So wird's gemacht: Verwenden der Kurzhandsyntax mit Azure CLI

Viele Azure CLI-Parameter akzeptieren JSON-Werte, aber da es schwierig sein kann, JSON in eine Zeichenfolge zu flatten, unterstützt die Azure CLI Kurzhandsyntax. Die Kurzhandsyntax ist eine vereinfachte Darstellung einer JSON-Zeichenfolge.

Dieser Artikel enthält Beispiele für Kurzhandsyntax und zeigt, wie JSON als Datei übergeben wird.

Vollständige Kurzhandsyntax

Die Kurzhandsyntax im Full Value Format ist JSON umgeben von doppelten Anführungszeichen. Doppelte Anführungszeichen führen dazu, dass der JSON-Wert sowohl in der PowerShell- als auch in der Bash-Skriptsprache als Zeichenfolge übergeben wird. Hier ist ein JSON-Beispiel:

{
  "name": "Bill",
  "age": 20,
  "paid": true,
  "emails": [
    "Bill@microsoft.com",
    "Bill@outlook.com"
  ],
  "address": {
    "country": "USA",
    "company": "Microsoft",
    "details": {
      "line1": "15590 NE 31st St",
      "line2": "Redmond, WA"
    }
  }
}

Wenn Sie JSON in einem Parameterwert übergeben, werden die JSON-Daten abgeflacht und in doppelte Anführungszeichen eingeschlossen.

az some-command --contact "{name:Bill,age:20,paid:true,emails:[Bill@microsoft.com,Bill@outlook.com],address:{country:USA,company:Microsoft,details:{line1:'15590 NE 31st St',line2:'Redmond, WA'}}}"

Teilwert-Kurzhandsyntax

Die Kurzhandsyntax für einen Teilwert besteht aus zwei Teilen, die mit einem Gleichheitszeichen (=) zwischen dem Index key und dem Wert value verbunden sind. Hier ist ein Beispiel: key=value.

Der Wert kann eine vereinfachte Zeichenfolge, ein vollständiges Wertformat, JSON oder ein JSON-Dateipfad sein. Übergeben Sie mithilfe des bereitgestellten JSON-Beispiels Eigenschaften für den --contact Parameter in den folgenden Beispielen:

Verwenden Sie Partial Value für ein einzelnes Schlüssel-Wert-Paar.

az some-command --contact name=Bill

Verwenden Sie Partial Value für zwei Schlüssel-Wert-Paare. Beachten Sie das Leerzeichen, das die beiden Paare trennt.

az some-command --contact age=20 paid=true

Verwenden Sie Partial Value für das zweite Element.

az some-command --contact emails[1]="Bill@outlook.com"

Nutzen Sie Partial Value für die Details-Eigenschaft der Adresse.

az some-command --contact address.details="{line1:'15590 NE 31st St',line2:'Redmond, WA'}"

Vollständige und teilweise Kurzhandsyntax kombinieren

Sie können eine vollständige und teilweise Wertsyntax kombinieren, aber immer mit Full Value gefolgt von Partial Valuebeginnen. Wenn Sie die Reihenfolge umkehren, enthalten die endgültigen Daten nur das Full Value ohne die in Partial Value definierten Eigenschaften.

Verwenden Sie Full Value gefolgt von Partial Value:

az some-command --contact "{name:Bill,age:20,paid:true,emails:[Bill@microsoft.com,Bill@outlook.com]}" motto="One man's bug is another man's lesson."

Sie können auch ein neues Element der Listeneigenschaft in Full Value einpatchen. Sie können beispielsweise die zweite E-Mail-Adresse wie folgt Partial Valuefestlegen:

az some-command --contact "{name:Bill,age:20,paid:true,emails:[Bill@microsoft.com]}" emails[1]="Bill@outlook.com" motto="One man's bug is another man's lesson."

Übergeben von JSON in einer Datei

Es ist auch möglich, eine JSON-Datei als Parameterwert zu übergeben. Dies ist der empfohlene Ansatz beim Arbeiten mit komplexem JSON.

az some-command --contact address.details=./address_details.JSON

Zeichenfolge für einfache Anführungszeichen

Single Quotes String wird verwendet, um einen Zeichenfolgenwert mit Sonderzeichen zu übergeben: :, ,, {, }, [, ], null, und ??Leerzeichen. Diese Zeichen haben häufig andere Bedeutungen beim Analysieren der Kurzhandsyntax. Einzelne Anführungszeichen weisen den Parser an, alles als Zeichenfolge zu behandeln.

Übergeben Sie einen Zeichenfolgenwert mit einem Leerzeichen und anderen Sonderzeichen.

Hier ist ein Beispiel-JSON, das als Wert im --contact-Parameter übergeben wird:

{
  "name": "Bill RP",
  "age": 20,
  "paid": true,
  "data": "{a: [1, 2]}"
}

Verwenden Sie einfache Anführungszeichen im Full Value Format:

az some-command --contact "{name:'Bill RP',age:20,paid:true,data:'{a: [1, 2]}'}"

Verwenden Sie einfache Anführungszeichen im Partial Value Format:

az some-command --contact name="'Bill RP'" data="'{a: [1, 2]}'"

Im nächsten Beispiel ist es auch möglich, einzelne Anführungszeichen für den name Schlüssel zu entfernen. Der Parser unterscheidet nicht zwischen einem Full Value Ausdruck, null wert oder dem ?? Flag.

Format verwenden Partial Value :

az some-command --contact name="Bill RP"

Mit Apostrophen arbeiten

Das Apostrophzeichen (') benötigt ein spezielles Escapezeichen (/') in einem String mit einfachen Anführungszeichen, um das Ende eines Strings mit einfachen Anführungszeichen zu unterscheiden. Ein Schrägstrich (/) ist ein Escapezeichen nur nach einem Apostroph (') in einer einzelnen Anführungszeichenzeichenfolge. Wenn / nicht in einfache Anführungszeichen steht oder / nicht nach ' kommt, ist / ein normales Zeichen.

Passformat Full Value :

az some-command --contact "{name:'bill'/s',age:20,paid:true}"

Passformat Partial Value :

az some-command --contact name="'bill'/s'"

Wenn value nicht in einfachen Anführungszeichen steht, müssen Sie danach kein Escapezeichen hinzufügen '.

Passformat Partial Value :

az some-command --contact name="bill's"

Hier sehen Sie ein weiteres Beispiel mit dem folgenden JSON:

{
  "name": "Bill",
  "motto": "One man's bug is another man's lesson.",
  "age": 20,
  "paid": true,
  "emails": [
    "Bill@microsoft.com",
    "Bill@outlook.com"
  ]
}

Full Value Verwenden Sie im Format eine einzelne Anführungszeichenzeichenfolge, und ersetzen Sie die ' Zeichenfolge durch '/.

az some-command --contact "{name:Bill,motto:'One man'/s bug is another man'/s lesson.',age:20,paid:true,emails:[Bill@microsoft.com,Bill@outlook.com]}"

Im Partial Value Format kann ein Wert, der ein Apostroph enthält, als Zeichenfolge analysiert werden, umgeben von doppelten Anführungszeichen.

az some-command --contact motto="One man's bug is another man's lesson."

Arbeiten mit NULL-Werten

Übergeben des Worts "null" als Zeichenfolgenwert

Irgendwann müssen Sie einen "null"-Zeichenfolgenwert übergeben. Um einen null Wert zu unterscheiden, muss es sich um eine einzelne Anführungszeichenzeichenfolge sein. Wenn Sie beispielsweise die Zeichenfolge "null" an die Namenseigenschaft im --contact Parameter übergeben möchten:

JSON:

{
  "name": "null",
  "age": 20,
  "paid": true
}

Format verwenden Full Value :

az some-command --contact "{name:'null',age:20,paid:true}"

Format verwenden Partial Value :

az some-command --contact name="'null'"

Geben Sie einen Wert null weiter

Kurzhandsyntax unterstützt das null Schlüsselwort in beiden Formaten, Full Value und Partial Value.

Beispiel: Wenn Sie das folgende Objekt mit einer nullWertadresseneigenschaft im --contact Parameter übergeben möchten:

{
  "name": "Bill",
  "age": 20,
  "paid": true,
  "emails": [
    "Bill@microsoft.com",
    "Bill@outlook.com"
  ],
  "address": null
}

Format verwenden Full Value :

az some-command --contact "{name:Bill,age:20,paid:true,emails:[Bill@microsoft.com,Bill@outlook.com],address:null}"

Format verwenden Partial Value :

az some-command --contact name=Bill address=null

Verwenden eines null Werts in Aktualisierungsbefehlen

Bei Aktualisierungsbefehlen wird häufig ein null Wert zum Aufheben der Eigenschaften eines Objekts oder zum Entfernen von Elementen eines Arrays oder eines Wörterbuchs verwendet.

{
  "contact": {
    "name": "Bill",
    "age": 20,
    "paid": true,
    "emails": [
      "Bill@microsoft.com",
      "Bill@outlook.com"
    ],
    "address": {
      "country": "USA",
      "company": "Microsoft",
      "details": {
        "line1": "15590 NE 31st St",
        "line2": "Redmond, WA"
      }
    }
  },

  "other_properties": {}
}

Wenn bereits eine Ressource mit den oben gezeigten JSON-Werten vorhanden ist, setzt das Übergeben eines null Werts in einem Aktualisierungsbefehl den Wert des Schlüssels zurück.

az some-update-command --contact address=null

Hier ein weiteres Beispiel, das das erste Element der E-Mail-Adresse einer Ressource entfernt:

az some-update-command --emails [0]=null

Verwenden Sie ??, um Hilfe anzuzeigen.

Die Verwendung von doppelten Fragezeichen ?? ist ein spezielles Schlüsselwort, um die verfügbare Hilfe für einen Parameter oder eine Untereigenschaft anzuzeigen. Sie kann auch in der Kurzhandsyntax verwendet werden, um Hilfe zu erhalten.

Verwenden Sie ??, um die Hilfemeldung eines Parameters anzuzeigen.

Hilfemeldung des --contact Parameters anzeigen:

az some-command --contact "??"

Verwenden Sie ?? im Full Value-Format

Hilfemeldung des --contant Parameters beim Schreiben Full Value anzeigen:

az some-command --contact "{??"

az some-command --contact "{name:Bill,??"

Hilfemeldung der --contant.address Eigenschaft anzeigen, wenn der Full Value geschrieben wird:

az some-command --contact "{name:Bill,address:??"

Hilfemeldung der --contant.address.country Eigenschaft anzeigen, wenn der Full Value geschrieben wird:

az some-command --contact "{name:Bill,address:{country:??"

Hilfemeldung der --contant.emails Eigenschaft anzeigen, wenn der Full Value geschrieben wird:

az some-command --contact "{name:Bill,address:{country:USA},emails:??"

Zeigen Sie die Hilfemeldung des Eigenschaftselements --contant.emails an, wenn Sie Full Value schreiben.

az some-command --contact "{name:Bill,address:{country:USA},emails:[??"

Verwenden Sie ?? im Partial Value-Format

Hilfemeldung der --contant.address Eigenschaft anzeigen, wenn der Partial Value geschrieben wird:

az some-command --contact address="??"

Hilfemeldung der --contant.emails Eigenschaft anzeigen, wenn der Partial Value geschrieben wird:

az some-command --contact emails="??"

Zeigen Sie die Hilfemeldung des Eigenschaftselements --contant.emails an, wenn Sie Partial Value schreiben.

az some-command --contact emails[0]="??"

Siehe auch

• Unterschiede zwischen Skripting-Sprachen – JSON-Strings