Décrire, répertorier et supprimer des types

Cette page explique comment décrire et répertorier des types, et en supprimer de votre projet.

Avant de commencer

Décrire des fournisseurs de types

Un fournisseur de types est une API tierce intégrée à Deployment Manager en tant que type. Vous pouvez décrire un fournisseur de types unique, obtenir la liste de tous les fournisseurs, ou répertorier tous les types proposés par un fournisseur.

Décrire un fournisseur de types unique

Vous pouvez décrire un fournisseur de types pour obtenir des informations telles que l'URL du document descripteur ainsi que les options d'API avancées qui ont été définies pour cette API.

gcloud

Exécutez la commande type-providers describe pour décrire un fournisseur de types :

gcloud beta deployment-manager type-providers describe [TYPE_PROVIDER_NAME]

L'outil gcloud renvoie une réponse semblable à celle-ci :

collectionOverrides:
- collection: /emailAddresses/v1beta/people
  options:
    inputMappings:
    - fieldName: emailAddress.displayName
      location: BODY
      methodMatch: ^create$
      value: $.resource.properties.displayName
    - fieldName: displayName
      location: PATH
      methodMatch: ^update$
      value: $.resource.properties.displayName
description: ''
descriptorUrl: https://www.example.com/emailAddresses/beta/rest
id: '2359554699942999151'
insertTime: '2017-02-06T15:45:04.241-08:00'
name: test-api
operation:
  endTime: '2017-02-06T15:45:04.743-08:00'
  id: '5242470992516002927'
  kind: deploymentmanager#operation
  name: operation-1486424704162-547e5387a18d1-40c505fc-a29b95cc
  operationType: insert
  progress: 100
  startTime: '2017-02-06T15:45:04.317-08:00'
  status: DONE
  targetId: '2359554699942999151'
  targetLink: https://www.googleapis.com/deploymentmanager/v2beta/projects/example-project/global/typeProviders/test-api
  user: user@example.com

API

Envoyez une requête GET à l'URI suivant :

https://www.googleapis.com/deploymentmanager/v2beta/projects/[PROJECT_ID]/global/typeProviders/[TYPE_PROVIDER_NAME]

Obtenir la liste des types proposés par un fournisseur de types

Un fournisseur de types expose toutes les ressources de l'API sous-jacente en tant que types de base. Vous pouvez obtenir la liste des types de base proposés par un fournisseur.

gcloud

Pour obtenir la liste des types de base proposés par un fournisseur de types :

gcloud beta deployment-manager types list --provider=[TYPE_PROVIDER]

API

Envoyez une requête GET à l'URI suivant :

GET https://www.googleapis.com/deploymentmanager/v2beta/projects/[PROJECT_ID]/global/typeProviders/[TYPE_PROVIDER_NAME]/types

Deployment Manager renvoie une liste de ressources comme la suivante :

{
 "types": [
  {
   "kind": "deploymentmanager#typeInfo",
   "name": "/api/v1/resources/{resourceId}",
   "title": "Example API",
   "documentationLink": "https://www.example.com/docs"
  },
  {
   "kind": "deploymentmanager#typeInfo",
   "name": "/api/v1/resources/{resourceId}/endpoints",
   "title": "Example API",
   "documentationLink": "https://www.example.com/docs"
  },
  {
   "kind": "deploymentmanager#typeInfo",
   "name": "/api/v1/moreResources/{resourceId}",
   "title": "Example API",
   "documentationLink": "https://www.example.com/docs"
  },...

Répertorier les fournisseurs de types

Vous pouvez obtenir la liste de vos fournisseurs de types via l'outil gcloud ou l'API.

gcloud

Pour répertorier vos fournisseurs de types, exécutez une requête type-providers list :

gcloud beta deployment-manager type-providers list

API

Dans l'API, envoyez une requête GET à la liste globale des fournisseurs de types :

GET https://www.googleapis.com/deploymentmanager/v2/projects/[PROJECT_ID]/global/typeProviders

Pour en savoir plus, consultez la documentation de la méthode list.

Décrire des types composites

Un type composite est un ensemble de modèles qui ont été ajoutés de manière permanente à Deployment Manager en tant que types. Vous pouvez décrire un type composite unique ou obtenir la liste des types composites disponibles pour le projet.

Décrire un type composite unique

Vous pouvez décrire un type composite unique pour obtenir des informations sur le type.

gcloud

Exécutez la commande types describe pour décrire un type :

gcloud beta deployment-manager types describe [COMPOSITE_TYPE_NAME] --provider composite

API

Envoyez une requête GET à l'URI suivant :

https://www.googleapis.com/deploymentmanager/v2beta/projects/[PROJECT_ID]/global/compositeTypes/[COMPOSITE_TYPE_NAME]

Répertorier les types composites

Vous pouvez obtenir la liste de vos types composites via l'outil gcloud ou l'API.

gcloud

Pour répertorier vos types composites, exécutez une requête types list :

gcloud beta deployment-manager types list --provider composite

API

Dans l'API, envoyez une requête GET à la liste globale des types :

GET https://www.googleapis.com/deploymentmanager/v2/projects/[PROJECT_ID]/global/types

Pour en savoir plus, consultez la documentation de la méthode list.

Supprimer un fournisseur de types

gcloud

Pour supprimer un fournisseur de types, exécutez une requête type-providers delete. Exemple :

gcloud beta deployment-manager type-providers delete [TYPE_PROVIDER]

API

Dans l'API, envoyez une requête DELETE au fournisseur de types que vous souhaitez supprimer :

DELETE https://www.googleapis.com/deploymentmanager/v2beta/projects/[PROJECT_ID]/global/typeProviders/[TYPE_PROVIDER]

Pour en savoir plus, consultez la documentation de la méthode delete.

Supprimer un type composite

gcloud

Pour supprimer un type composite, exécutez une requête types delete. Exemple :

gcloud beta deployment-manager types delete [COMPOSITE_TYPE]

API

Dans l'API, envoyez une requête DELETE au type que vous souhaitez supprimer :

DELETE https://www.googleapis.com/deploymentmanager/v2beta/projects/[PROJECT_ID]/global/compositeTypes/[COMPOSITE_TYPE]

Pour en savoir plus, consultez la documentation de la méthode delete.

Étapes suivantes