Sicherstellen von Parameter- und Variablentypen

  • 4 Minuten

Parameter und Variablen sind wichtige Komponenten für das Anpassen des Pipelineverhaltens. Diese ermöglichen das Übergeben von Laufzeitwerten an Pipelineaufgaben und -skripts sowie das Definieren von Variablen für die Verwendung in verschiedenen Pipelinestages. Bei der Verwendung von Parametern und Variablen in Pipelines ist es wichtig, deren Datentypen richtig zu definieren, um unerwartetes Verhalten zu vermeiden, das sich auf die Sicherheit oder die Pipelineausführung des Projekts auswirken kann.

Parameter- und Variablentypen

Parameter und Variablen sind für die Pipelineanpassung von entscheidender Bedeutung, da sie Flexibilität und dynamischere Pipelineskripts ermöglichen. Sie können sie verwenden, um Werte wie Verbindungszeichenfolgen, Umgebungsvariablen und andere vertrauliche Daten zu speichern. Die ordnungsgemäße Definition ihrer Datentypen ist auch wichtig, um unerwartete Fehler oder Sicherheitsrisiken aufgrund einer falschen Nutzung zu vermeiden.

Hinzufügen eines Parameters oder einer Variablen zu Ihrer Pipeline

parameters:
- name: myParameterName
  type: myDataType
  default: myDefaultValue

variables:
- name: myReadOnlyVar
  value: myValue
  readonly: true

Ersetzen Sie myParameterName, myDataType, myDefaultValue, myReadOnlyVar und myValue durch Ihre gewünschten Werte.

Beispiel:

parameters:
- name: image
  displayName: Pool Image
  type: string
  default: ubuntu-latest
  values:
  - windows-latest
  - ubuntu-latest
  - macOS-latest

variables:
 - name: eShopOnWeb
   value: myValue

Verwenden der richtigen Datentypen beim Definieren von Parametern

Azure Pipelines unterstützt die folgenden Datentypen:

  • Zeichenfolge
  • boolean
  • number
  • Objekt
  • Schritt

Im Gegensatz zu Variablen können Pipelineparameter während der Ausführung nicht von einer Pipeline geändert werden. Parameter verfügen über Datentypen wie number und string, und sie können auf eine Teilmenge von Werten beschränkt werden. Das Einschränken der Parameter ist nützlich, wenn ein von Benutzer*innen konfigurierbarer Teil der Pipeline einen Wert nur aus einer eingeschränkten Liste annehmen soll. Durch die Einrichtung wird sichergestellt, dass die Pipeline keine beliebigen Daten annimmt.

Definieren von Geheimnissen als Geheimnisvariablen oder als Teil einer Variablengruppe

Sie können Azure Key Vault verwenden, um Geheimnisse zu speichern und dann in Ihrem Pipelineskript darauf zu verweisen.

Beispiel:

variables:
 - name: eShopOnWeb
   value: myValue

# You can define variable groups to reuse variables across pipelines
# and to manage sensitive data centrally.

variables:
- group: eShopOnWeb
- name: ConnectionStrings.CatalogConnection
  value: '$(CatalogConnectionToken)'

Verwenden der Eigenschaft readonly, um sicherzustellen, dass Variablen während der Ausführung nicht von einer Pipeline geändert werden

Dies ist nützlich, wenn Sie sicherstellen möchten, dass eine Variable während der Ausführung nicht von einer Pipeline geändert wird. Mit dieser Eigenschaft können Sie beispielsweise gewährleisten, dass eine Variable während der Ausführung nicht von einer Pipeline geändert wird.

Beispiel:

variables:
- name: eShopOnWeb
  value: myValue
  readonly: true

Probieren Sie es aus!

Eine gute Möglichkeit, das Sicherstellen von Parameter- und Variablentypen zu üben, besteht darin, eine Pipeline mit Parametern und Variablen zu erstellen. Definieren Sie Ihre Parameter und Variablen mit der richtigen Syntax und typsicherer Sprache. Verwenden Sie dann die Parameterüberprüfung, um sicherzustellen, dass die Pipeline ordnungsgemäß ausgeführt wird. Verwenden Sie schließlich sichere Variablengruppen, um vertrauliche Informationen zu schützen. Testen Sie Ihre Pipeline, um sicherzustellen, dass sie wie erwartet funktioniert, und verwenden Sie die Pipelineprotokolle, um Probleme zu beheben.

Erstellen Sie außerdem eine YAML-Pipeline, die einen Parameter mit einem falschen Typ enthält, und führen Sie sie aus. Korrigieren Sie dann den Fehler, indem Sie den richtigen Typ für den Parameter deklarieren und die Pipeline erneut ausführen. So können Sie besser nachvollziehen, wie wichtig es ist, den Typ von Parametern und Variablen im Pipelinecode beizubehalten.

Weitere Informationen zu Variablen und Parametern finden Sie hier: