Sicherstellen von Parameter- und Variablentypen

Abgeschlossen

Parameter und Variablen sind wesentliche Komponenten zum Anpassen des Pipelineverhaltens. Diese ermöglichen das Übergeben von Laufzeitwerten an Pipelineaufgaben und Skripts und das Definieren von Variablen für die Verwendung in verschiedenen Pipelinephasen. Bei der Verwendung von Parametern und Variablen in Pipelines ist es wichtig, ihre Datentypen korrekt zu definieren, um unerwartete Verhaltensweisen zu vermeiden, die sich auf die Sicherheit oder Pipelineausführung des Projekts auswirken könnten.

Parameter- und Variablentypen

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

Hinzufügen eines Parameters oder einer Variablen zur Pipeline

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

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

Ersetzen Sie myParameterNamedie werte, myDataType, , myDefaultValuemyReadOnlyVarund myValue ersetzen Sie sie durch die 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 der Parameter

Azure Pipelines unterstützt die folgenden Datentypen:

  • Schnur
  • Boolescher Wert
  • Zahl
  • Objekt
  • Schritt

Im Gegensatz zu Variablen können Pipelineparameter während der Ausführung nicht von einer Pipeline geändert werden. Parameter haben 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 vom Benutzer konfigurierbarer Teil der Pipeline nur einen Wert aus einer eingeschränkten Liste annehmen sollte. Durch das Setup wird sichergestellt, dass die Pipeline keine beliebigen Daten übernimmt.

Definieren geheimer Schlüssel als geheime Variablen oder als Teil einer Variablengruppe

Sie können Azure Key Vault verwenden, um geheime Schlüssel 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 Sie die readonly Eigenschaft, um sicherzustellen, dass Variablen während der Ausführung nicht von einer Pipeline geändert werden.

Es ist nützlich, wenn Sie sicherstellen möchten, dass eine Variable während der Ausführung nicht von einer Pipeline geändert wird. Sie können diese Eigenschaft beispielsweise verwenden, um sicherzustellen, dass eine Variable während der Ausführung nicht von einer Pipeline geändert wird.

Beispiel:

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

Sich selbst herausfordern

Eine hervorragende Möglichkeit, die Sicherstellung von Parameter- und Variablentypen zu üben, besteht darin, eine Pipeline zu erstellen, die Parameter und Variablen verwendet. Definieren Sie Ihre Parameter und Variablen mithilfe der richtigen Syntax und typsicheren 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 erwartungsgemäß funktioniert, und verwenden Sie die Pipelineprotokolle, um Probleme zu beheben.

Versuchen Sie außerdem, eine YAML-Pipeline zu erstellen, 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. Es hilft Ihnen zu verstehen, wie wichtig es ist, den Typ von Parametern und Variablen im Pipelinecode beizubehalten.

Weitere Informationen zu Variablen und Parametern finden Sie unter: