Typanbieter in einer Konfiguration aufrufen

Diese Seite beschreibt, wie Sie einen Typanbieter verwenden, den Sie mit Deployment Manager erstellt haben. Es wird nicht beschrieben, wie ein Typanbieter erstellt wird. Weitere Informationen zur Erstellung eines Typanbieters finden Sie unter Typanbieter erstellen.

Hinweise

  • Wenn Sie die Befehlszeilenbeispiele in dieser Anleitung verwenden möchten, installieren Sie das gcloud-Befehlszeilentool.
  • Wenn Sie die API-Beispiele in dieser Anleitung verwenden möchten, richten Sie den API-Zugriff ein.

Auf Typanbieter zugreifen

Typanbieter sind Ressourcen auf Projektbasis und gemäß den Berechtigungen zugänglich, die in der Dokumentation zur Zugriffssteuerung beschrieben sind. Das bedeutet:

  • Projektbearbeiter und -betrachter können für dieses Projekt verfügbare Typen erstellen und verwenden.
  • Typbetrachter können eine Liste von Typen abrufen und die Typen verwenden, die für dieses Projekt verfügbar sind.

Sie können auch ein anderes Projekt als Typbetrachter hinzufügen, sodass dieses auf Ihre Typen zugreifen kann. Weitere Informationen finden Sie unter Typen für andere Projekte freigeben.

Typanbieter verwenden

Wenn Sie einen Typ verwenden möchten, der von einem Typanbieter in Ihrer Konfiguration angezeigt wird, verwenden Sie die folgende Syntax:

type: [PROJECT_ID]/[TYPE_NAME]:[COLLECTION]

  • Wenn diese API durch eine OpenAPI-Spezifikation abgesichert ist, wäre [COLLECTION] der REST-Bezeichner für den Pfad zur Ressource. Beispiel:

    type: my-project/emailAddressesTypeProvider:emailAddresses/v1beta/people

  • Wenn die API durch ein Google Discovery-Dokument abgesichert ist, ist [COLLECTION] der Ressourcenpfad, der zur gewünschten Ressource in der API führt. Um beispielsweise einen Dienstkontoschlüssel zu erstellen, würde die Sammlung so aussehen:

    type: my-project/example-type-provider:projects.serviceAccounts.keys

Setzen Sie nun die Konfiguration Ihres Typs fort, wie es die zugrunde liegende API erfordert:

resources:
- name: Jane
  type: my-project/emailAddressesTypeProvider:emailAddresses/v1beta/people
  properties:
  - displayName: Jane
    email: jane@example.com
    ...

Nächste Schritte