az connectedmachine extension

Note

Den här referensen är en del av tillägget connectedmachine för Azure CLI (version 2.75.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az connectedmachine-tillägg kommando. Läs mer om tillägg.

Hantera ett VM-tillägg på en Azure Arc-aktiverad server.

Kommandon

Name Description Typ Status
az connectedmachine extension create

Skapa ett tillägg.

 Extension GA
az connectedmachine extension delete

Ta bort ett tillägg.

 Extension GA
az connectedmachine extension image

Hantera metadata för VM-tillägg som är tillgängliga för Azure Arc-aktiverade servrar.

 Extension GA
az connectedmachine extension image list

Visa en lista över alla tilläggsversioner baserat på plats, utgivare, extensionType.

 Extension GA
az connectedmachine extension image show

Hämta ett tilläggsmetadata baserat på plats, utgivare, extensionType och version.

 Extension GA
az connectedmachine extension list

Hämta alla tillägg för en dator som inte är Azure.

 Extension GA
az connectedmachine extension publisher

Hantera Publisher.

 Extension GA
az connectedmachine extension publisher list

Visa en lista över alla tilläggsutgivare baserat på platsen.

 Extension GA
az connectedmachine extension show

Visa ett tillägg för en dator som inte är Azure.

 Extension GA
az connectedmachine extension type

Hantera tilläggstyp.

 Extension GA
az connectedmachine extension type list

Visa en lista över alla tilläggstyper baserat på plats och utgivare.

 Extension GA
az connectedmachine extension update

Uppdatera ett tillägg.

 Extension GA
az connectedmachine extension wait

Placera CLI i vänteläge tills ett villkor uppfylls.

 Extension GA

az connectedmachine extension create

Skapa ett tillägg.

az connectedmachine extension create --extension-name --name
                                     --machine-name
                                     --resource-group
                                     [--acquire-policy-token]
                                     [--auto-upgrade-min --auto-upgrade-minor-version {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--change-reference]
                                     [--enable-auto-upgrade --enable-automatic-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--force-update-tag]
                                     [--instance-view]
                                     [--location]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--protected-settings]
                                     [--publisher]
                                     [--settings]
                                     [--tags]
                                     [--type]
                                     [--type-handler-version]

Exempel

Exempelkommando för att skapa tillägget

az connectedmachine extension create --name CustomScriptExtension --location eastus2euap --type CustomScriptExtension --publisher Microsoft.Compute --type-handler-version 1.10 --machine-name myMachine --resource-group myResourceGroup

Obligatoriska parametrar

--extension-name --name -n

Namnet på datortillägget.

--machine-name

Namnet på den dator där tillägget ska skapas eller uppdateras.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--auto-upgrade-min --auto-upgrade-minor-version

Anger om tillägget ska använda en nyare delversion om en är tillgänglig vid distributionstillfället. När tillägget har distribuerats uppgraderas dock inte mindre versioner om de inte distribueras om, även med den här egenskapen inställd på true.

Egenskap Värde
Parametergrupp: Properties Arguments
Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--enable-auto-upgrade --enable-automatic-upgrade

Anger om tillägget ska uppgraderas automatiskt av plattformen om det finns en nyare version tillgänglig.

Egenskap Värde
Parametergrupp: Properties Arguments
Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--force-update-tag

Hur tilläggshanteraren ska tvingas uppdatera även om tilläggskonfigurationen inte har ändrats.

Egenskap Värde
Parametergrupp: Properties Arguments
--instance-view

Instansvyn för datortillägget. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap Värde
Parametergrupp: Properties Arguments
--location -l

Den geo-plats där resursen finns När den inte anges används platsen för resursgruppen.

Egenskap Värde
Parametergrupp: Resource Arguments
--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

Egenskap Värde
Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--protected-settings

Tillägget kan innehålla antingen protectedSettings eller protectedSettingsFromKeyVault eller inga skyddade inställningar alls. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap Värde
Parametergrupp: Properties Arguments
--publisher

Namnet på tilläggshanterarens utgivare.

Egenskap Värde
Parametergrupp: Properties Arguments
--settings

Json har formaterat offentliga inställningar för tillägget. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap Värde
Parametergrupp: Properties Arguments
--tags

Resursetiketter. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap Värde
Parametergrupp: Resource Arguments
--type

Anger filnamnstilläggets typ. ett exempel är "CustomScriptExtension".

Egenskap Värde
Parametergrupp: Properties Arguments
--type-handler-version

Anger versionen av skripthanteraren.

Egenskap Värde
Parametergrupp: Properties Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az connectedmachine extension delete

Ta bort ett tillägg.

az connectedmachine extension delete [--acquire-policy-token]
                                     [--change-reference]
                                     [--extension-name --name]
                                     [--ids]
                                     [--machine-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]
                                     [--yes]

Exempel

Exempelkommando för borttagning av tillägg

az connectedmachine extension delete --name myName --machine-name myMachine --resource-group myResourceGroup

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--extension-name --name -n

Namnet på datortillägget.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--machine-name

Namnet på den dator där tillägget ska tas bort.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

Egenskap Värde
Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--yes -y

Fråga inte efter bekräftelse.

Egenskap Värde
Standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az connectedmachine extension list

Hämta alla tillägg för en dator som inte är Azure.

az connectedmachine extension list --machine-name
                                   --resource-group
                                   [--expand]
                                   [--max-items]
                                   [--next-token]

Exempel

Exempelkommando för tilläggslista

az connectedmachine extension list --machine-name myMachine --resource-group myResourceGroup

Obligatoriska parametrar

--machine-name

Namnet på den dator som innehåller tillägget.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--expand

Det expanderingsuttryck som ska tillämpas på åtgärden.

--max-items

Totalt antal objekt som ska returneras i kommandots utdata. Om det totala antalet tillgängliga objekt är mer än det angivna värdet anges en token i kommandots utdata. Om du vill återuppta sidnumreringen anger du tokenvärdet i --next-token argument för ett efterföljande kommando.

Egenskap Värde
Parametergrupp: Pagination Arguments
--next-token

Token för att ange var sidnumrering ska börja. Detta är tokenvärdet från ett tidigare trunkerat svar.

Egenskap Värde
Parametergrupp: Pagination Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az connectedmachine extension show

Visa ett tillägg för en dator som inte är Azure.

az connectedmachine extension show [--extension-name --name]
                                   [--ids]
                                   [--machine-name]
                                   [--resource-group]
                                   [--subscription]

Exempel

Exempelkommando för tilläggsvisning

az connectedmachine extension show --name CustomScriptExtension --machine-name myMachine --resource-group myResourceGroup

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--extension-name --name -n

Namnet på datortillägget.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--machine-name

Namnet på den dator som innehåller tillägget.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parametergrupp: Resource Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az connectedmachine extension update

Uppdatera ett tillägg.

az connectedmachine extension update [--acquire-policy-token]
                                     [--add]
                                     [--auto-upgrade-min --auto-upgrade-minor-version {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--change-reference]
                                     [--enable-auto-upgrade --enable-automatic-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--extension-name --name]
                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--force-update-tag]
                                     [--ids]
                                     [--instance-view]
                                     [--machine-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--protected-settings]
                                     [--publisher]
                                     [--remove]
                                     [--resource-group]
                                     [--set]
                                     [--settings]
                                     [--subscription]
                                     [--tags]
                                     [--type]
                                     [--type-handler-version]

Exempel

Exempelkommando för tilläggsuppdatering

az connectedmachine extension update --name CustomScriptExtension --type CustomScriptExtension --publisher Microsoft.Compute --type-handler-version 1.10 --machine-name myMachine --resource-group myResourceGroup

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--add

Lägg till ett objekt i en lista över objekt genom att ange en sökväg och nyckelvärdepar. Exempel: --add property.listProperty <key=value, string or JSON string>.

Egenskap Värde
Parametergrupp: Generic Update Arguments
--auto-upgrade-min --auto-upgrade-minor-version

Anger om tillägget ska använda en nyare delversion om en är tillgänglig vid distributionstillfället. När tillägget har distribuerats uppgraderas dock inte mindre versioner om de inte distribueras om, även med den här egenskapen inställd på true.

Egenskap Värde
Parametergrupp: Properties Arguments
Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--enable-auto-upgrade --enable-automatic-upgrade

Anger om tillägget ska uppgraderas automatiskt av plattformen om det finns en nyare version tillgänglig.

Egenskap Värde
Parametergrupp: Properties Arguments
Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--extension-name --name -n

Namnet på datortillägget.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--force-string

När du använder "set" eller "add" bevarar du strängliteraler i stället för att försöka konvertera till JSON.

Egenskap Värde
Parametergrupp: Generic Update Arguments
Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--force-update-tag

Hur tilläggshanteraren ska tvingas uppdatera även om tilläggskonfigurationen inte har ändrats.

Egenskap Värde
Parametergrupp: Properties Arguments
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--instance-view

Instansvyn för datortillägget. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap Värde
Parametergrupp: Properties Arguments
--machine-name

Namnet på den dator som innehåller tillägget.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

Egenskap Värde
Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--protected-settings

Tillägget kan innehålla antingen protectedSettings eller protectedSettingsFromKeyVault eller inga skyddade inställningar alls. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap Värde
Parametergrupp: Properties Arguments
--publisher

Namnet på tilläggshanterarens utgivare.

Egenskap Värde
Parametergrupp: Properties Arguments
--remove

Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list <indexToRemove> ELLER --remove propertyToRemove.

Egenskap Värde
Parametergrupp: Generic Update Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--set

Uppdatera ett objekt genom att ange en egenskapssökväg och ett värde som ska anges. Exempel: --set property1.property2=<value>.

Egenskap Värde
Parametergrupp: Generic Update Arguments
--settings

Json har formaterat offentliga inställningar för tillägget. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap Värde
Parametergrupp: Properties Arguments
--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--tags

Resursetiketter. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap Värde
Parametergrupp: Resource Arguments
--type

Anger filnamnstilläggets typ. ett exempel är "CustomScriptExtension".

Egenskap Värde
Parametergrupp: Properties Arguments
--type-handler-version

Anger versionen av skripthanteraren.

Egenskap Värde
Parametergrupp: Properties Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az connectedmachine extension wait

Placera CLI i vänteläge tills ett villkor uppfylls.

az connectedmachine extension wait [--acquire-policy-token]
                                   [--change-reference]
                                   [--created]
                                   [--custom]
                                   [--deleted]
                                   [--exists]
                                   [--extension-name --name]
                                   [--ids]
                                   [--interval]
                                   [--machine-name]
                                   [--resource-group]
                                   [--subscription]
                                   [--timeout]
                                   [--updated]

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--created

Vänta tills du har skapat med "provisioningState" på "Lyckades".

Egenskap Värde
Parametergrupp: Wait Condition Arguments
Standardvärde: False
--custom

Vänta tills villkoret uppfyller en anpassad JMESPath-fråga. T.ex. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Egenskap Värde
Parametergrupp: Wait Condition Arguments
--deleted

Vänta tills den har tagits bort.

Egenskap Värde
Parametergrupp: Wait Condition Arguments
Standardvärde: False
--exists

Vänta tills resursen finns.

Egenskap Värde
Parametergrupp: Wait Condition Arguments
Standardvärde: False
--extension-name --name -n

Namnet på datortillägget.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--interval

Avsökningsintervall i sekunder.

Egenskap Värde
Parametergrupp: Wait Condition Arguments
Standardvärde: 30
--machine-name

Namnet på den dator som innehåller tillägget.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--timeout

Maximal väntetid i sekunder.

Egenskap Värde
Parametergrupp: Wait Condition Arguments
Standardvärde: 3600
--updated

Vänta tills det har uppdaterats med provisioningState på Lyckades.

Egenskap Värde
Parametergrupp: Wait Condition Arguments
Standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False