Référence de l'interface CLI du projet

L'interface de ligne de commande IBM Cloud® ( IBM Cloud CLI) offre des possibilités supplémentaires pour les offres de services. Vous pouvez utiliser le CLI de IBM Cloud pour gérer les projets auxquels vous avez accès.

Avant de commencer

Installez l'interface de ligne de commande IBM Cloud.
Installez l'interface de programmation du projet en exécutant la commande suivante :

ibmcloud plugin install project

Vous êtes averti sur la ligne de commande lorsque des mises à jour de l'interface de ligne de commande et des plug-ins IBM Cloud sont disponibles. Veillez à garder votre interface de ligne de commande à jour afin de pouvoir utiliser les dernières commandes. Vous pouvez afficher la version actuelle de tous les plug-ins installés en exécutant la commande ibmcloud plugin list.

Projets

Commandes pour la ressource Projets.

`ibmcloud project select`

Alias : target

Permet de sélectionner un projet comme contexte actuel.

ibmcloud project select PROJECT_ID|PROJECT_NAME [--unset-project] [--output FORMAT] [-q, --quiet]

Exemples

ibmcloud project select db4da927-80bc-4161-960d-7ce2b5e1be96

Vous pouvez également effectuer une sélection par nom de projet

ibmcloud project select ProjectA

Pour désélectionner un projet

ibmcloud project select --unset-project

Options de commande

--unset-project (bool): Projet ciblé non défini
--output (chaîne): Choisissez un format de sortie - peut être 'json' ou 'table'. (par défaut 'table')
-q, --quiet (bool): Supprimer les messages prolixes.

ibmcloud project select --unset-project

`ibmcloud project create`

Créer un projet et mettre en place de manière asynchrone les outils pour le gérer. Ajoutez une architecture déployable en personnalisant la configuration. Une fois les modifications validées et approuvées, déployez les ressources configurées par le projet. Pour plus d'informations, voir Création d'un projet.

ibmcloud project create [--definition DEFINITION | --definition-name DEFINITION-NAME --definition-description DEFINITION-DESCRIPTION --definition-auto-deploy-mode DEFINITION-AUTO-DEPLOY-MODE --definition-monitoring-enabled=DEFINITION-MONITORING-ENABLED --definition-destroy-on-delete=DEFINITION-DESTROY-ON-DELETE --definition-store DEFINITION-STORE --definition-terraform-engine DEFINITION-TERRAFORM-ENGINE --definition-auto-deploy=DEFINITION-AUTO-DEPLOY] --location LOCATION --resource-group RESOURCE-GROUP [--configs CONFIGS] [--environments ENVIRONMENTS] [--output FORMAT] [-q, --quiet]

Options de commande

--definition (ProjectPrototypeDefinition)

Définition du projet. Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition=@path/to/file.json.

--location (chaîne)

Emplacement IBM Cloud où une ressource est déployée. Obligatoire.

Les valeurs admises sont: us-south, us-east, eu-gb, eu-de, ca-tor.

--resource-group (chaîne)

Nom du groupe de ressources dans lequel les données et les outils du projet sont créés. Obligatoire.

La longueur maximale est de 64 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/.

--configs (ProjectConfigPrototype[])

Les configurations de projet. Ces configurations sont incluses dans la réponse de la création d'un projet uniquement si un tableau de configuration est spécifié dans le contenu de la demande.

La valeur par défaut est []. La longueur maximale est de 100 éléments. La longueur minimale est de 0.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --configs=@path/to/file.json.

--environments (EnvironmentPrototype[])

Environnement du projet. Ces environnements sont inclus dans la réponse de la création d'un projet uniquement si un tableau d'environnement est spécifié dans le contenu de la demande.

La valeur par défaut est []. La longueur maximale est de 20 éléments. La longueur minimale est de 0.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --environments=@path/to/file.json.

--definition-name (chaîne)

Nom du projet. Il est unique au sein du compte dans toutes les régions. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La longueur minimale est de 1 caractères. La valeur doit correspondre à l'expression régulière /^(?!\\s)(?!.*\\s$)[^'"`\/<>{}\\x00-\\x1F]+$/.

--definition-description (chaîne)

Brève explication de l'utilisation du projet dans la configuration d'une architecture déployable. Il est possible de créer un projet sans fournir de description. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

La valeur par défaut est . La longueur maximale est de 1024 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.

--definition-auto-deploy-mode (chaîne)

Il s'agit d'un paramètre avancé du déploiement automatique qui indique comment le déploiement automatique doit se comporter lorsqu'il est activé. 2 options existent :

auto_approval approuvera automatiquement la configuration après validation sans confirmation de l'utilisateur.

manual_approval demandera la confirmation de l'utilisateur pour approuver la configuration après validation avant que le déploiement de la configuration ne commence. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

La valeur par défaut est manual_approval. Les valeurs autorisées sont : auto_approval, manual_approval.

--definition-monitoring-enabled (bool)

Indicateur booléen permettant d'activer la détection de dérive automatique. Ce champ permet d'effectuer un contrôle quotidien afin de comparer les configurations aux ressources déployées et de détecter toute différence. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

La valeur par défaut est false.

--definition-destroy-on-delete (bool)

Règle qui indique si le déploiement des ressources est annulé ou non lorsqu'un projet est supprimé. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

La valeur par défaut est true.

--definition-store (ProjectDefinitionStore)

Les détails nécessaires pour personnaliser les configurations du projet. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition-store=@path/to/file.json.

--definition-terraform-engine (ProjectTerraformEngineSettings)

Schéma expérimental - à des fins de prototypage. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition-terraform-engine=@path/to/file.json.

--definition-auto-deploy (bool)

Un indicateur booléen permettant d'activer le déploiement automatique des configurations. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

La valeur par défaut est false.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemples

ibmcloud project create \
    --definition '{"name": "acme-microservice", "description": "A microservice to deploy on top of ACME infrastructure.", "auto_deploy_mode": "manual_approval", "monitoring_enabled": false, "destroy_on_delete": true, "store": {"type": "gh", "url": "exampleString", "token": "exampleString", "config_directory": "exampleString"}, "terraform_engine": {"id": "exampleString", "type": "terraform-enterprise"}, "auto_deploy": false}' \
    --location us-south \
    --resource-group Default \
    --configs '[{"definition": {"compliance_profile": {}, "locator_id": "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global", "members": [{"name": "exampleString", "config_id": "exampleString"}], "description": "The stage account configuration.", "name": "account-stage", "authorizations": {"trusted_profile_id": "exampleString", "method": "exampleString", "api_key": "exampleString"}, "inputs": {"anyKey": "anyValue"}, "settings": {"anyKey": "anyValue"}, "environment_id": "exampleString"}, "schematics": {"workspace_crn": "crn:v1:staging:public:project:us-south:a/4e1c48fcf8ac33c0a2441e4139f189ae:bf40ad13-b107-446a-8286-c6d576183bb1::"}}]' \
    --environments '[{"definition": {"description": "exampleString", "name": "exampleString", "authorizations": {"trusted_profile_id": "exampleString", "method": "exampleString", "api_key": "exampleString"}, "inputs": {"anyKey": "anyValue"}, "compliance_profile": {}}}]'

Des options granulaires sont également disponibles pour les sous-zones des options de chaîne JSON:

ibmcloud project create \
    --location us-south \
    --resource-group Default \
    --configs '[projectConfigPrototype]' \
    --environments '[environmentPrototype]' \
    --definition-name exampleString \
    --definition-description exampleString \
    --definition-auto-deploy-mode manual_approval \
    --definition-monitoring-enabled=false \
    --definition-destroy-on-delete=true \
    --definition-store projectDefinitionStore \
    --definition-terraform-engine projectTerraformEngineSettings \
    --definition-auto-deploy=false

`ibmcloud project list`

Répertorier les projets existants. Les projets sont triés par ID. Note : Si l'option --all-pages n'est pas activée, la commande ne récupérera qu'une seule page de la collection.

ibmcloud project list [--token TOKEN] [--limit LIMIT] [--output FORMAT] [-q, --quiet]

Options de commande

--token (chaîne)

Le serveur utilise ce paramètre pour déterminer la première entrée renvoyée sur la page suivante. Si ce paramètre n'est pas spécifié, la première page logique est renvoyée.

La valeur par défaut est . La longueur maximale est de 1536 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.

--limit (int64)

Le nombre maximum de ressources à renvoyer. Le nombre de ressources renvoyées est identique, à l'exception de la dernière page.

La valeur par défaut est 10. La valeur maximale est de 100. Valeur minimale : 1.

--all-pages (bool)

Invoquer plusieurs requêtes pour afficher toutes les pages de la collection pour la liste.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemple

ibmcloud project list \
    --token exampleString \
    --limit 10

Exemple de sortie

Exemple de demande de liste de projets.

{
  "limit" : 10,
  "first" : {
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "next" : {
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/12349050-1234-ac97-0000-ba5a12fe9087"
  },
  "projects" : [ {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "href" : "https://projects.service.url/v1/projects/cfbf901-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "description" : "A project example.",
      "name" : "iaas-infra-prestage-env",
      "destroy_on_delete" : false
    },
    "location" : "us-south",
    "state" : "ready",
    "resource_group" : "Default",
    "resource_group_id" : "f37d2637ea814cfd9a1742683a713d24",
    "cumulative_needs_attention_view" : [ {
      "event" : "project.instance.update"
    }, {
      "event_id" : "489f0090-6d7c-4af5-8f20-9106543e4974"
    }, {
      "config_id" : "069ab83e-5016-4bf2-bd50-cc95cf678293"
    }, {
      "config_version" : 1
    } ]
  }, {
    "id" : "1123ed42-4356-efa1-1101-235900fe9087",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "href" : "https://projects.service.url/v1/projects/cfbf901-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "description" : "A project example.",
      "name" : "iaas-infra-stage-env",
      "destroy_on_delete" : false
    },
    "crn" : "crn:v1:staging:public:project:eu-de:a/06580d923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
    "location" : "eu-gb",
    "state" : "ready",
    "resource_group" : "Default",
    "resource_group_id" : "f37d2637ea814cfd9a1742683a713d24",
    "cumulative_needs_attention_view" : [ ]
  } ]
}

Chemin d'accès JMES par défaut

Une requête JMESPath sera appliquée par défaut à la sortie de cette commande, si l'utilisateur n'en a pas fourni une. La requête exacte dépendra du scénario et du format de sortie demandé. Vous pouvez voir la condition pour chaque requête JMESPath par défaut dans le tableau suivant :

Chemin d'accès JMES par défaut
Réponse	Sortie	Requête
Réussite	Valeur par défaut
	Tableau	`projects[].{id: id, name: definition.name, state: state}`
Erreur	Valeur par défaut
	Tableau	`projects[].{id: id, name: definition.name, state: state}`
Toutes les pages	Valeur par défaut
	Tableau	`projects[].{id: id, name: definition.name, state: state}`

Si une requête JMESPath personnalisée est fournie, elle remplacera toute requête JMESPath figurant dans le tableau ci-dessus.

`ibmcloud project get`

Obtenir des informations sur un projet.

ibmcloud project get [--id ID] [--output FORMAT] [-q, --quiet]

Options de commande

--id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

Exemple

ibmcloud project get \
    --id exampleString

Exemple de sortie

Exemple de réponse pour l'extraction d'un projet avec des configurations.

{
  "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
  "created_at" : "2023-02-22T19:51:23.253Z",
  "modified_at" : "2023-02-22T19:51:23.253Z",
  "href" : "https://projects.service.url/v1/projects/cfbf901-ab8e-ac97-b01b-ab5af830be8a",
  "definition" : {
    "name" : "acme-microservice",
    "description" : "A microservice to deploy on top of ACME infrastructure.",
    "auto_deploy_mode" : "manual_approval",
    "auto_deploy" : false,
    "destroy_on_delete" : true,
    "monitoring_enabled" : false
  },
  "configs" : [ {
    "id" : "673d79e4-52bf-4184-b8e9-d3ca3c110f96",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "common-variables",
      "description" : "The common-variables configuration."
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/673d79e4-52bf-4184-b8e9-d3ca3c110f96",
    "is_draft" : true,
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "state" : "draft",
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "update_available" : false,
    "version" : 1
  }, {
    "id" : "4a1d4ba2-54ba-43a7-975a-d82b5a7612d1",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "account-stage",
      "description" : "The stage account configuration. The stage account hosts test environments prestage, performance, stage. This configuration configures services that are common to all these environments and regions. It's a `terraform_template` type of configuration that points to a GitHub repository that hosts the terraform modules that a Schematics workspace can deploy."
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/4a1d4ba2-54ba-43a7-975a-d82b5a7612d1",
    "is_draft" : true,
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "state" : "draft",
    "update_available" : false,
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "version" : 1
  }, {
    "id" : "293c3c36-a094-4115-a12b-de0a9ca39be5",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "env-stage",
      "description" : "The stage environment configuration. It includes services that are common to all the environment regions. A blueprint must be used to configure all the services that are common to the stage regions. It's a `terraform_template` type of configuration that points to a GitHub repository that hosts the Terraform modules that a Schematics workspace can deploy."
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/293c3c36-a094-4115-a12b-de0a9ca39be5",
    "is_draft" : true,
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "state" : "draft",
    "update_available" : false,
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "version" : 1
  }, {
    "id" : "596e8656-9d4b-41a5-8340-b0cbe8bd374a",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "region-us-south-stage",
      "description" : "The stage `us-south` configuration. A blueprint must be used to configure the Virtual Private Cloud and Red Hat OpenShift stage `us-south`."
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/596e8656-9d4b-41a5-8340-b0cbe8bd374a",
    "is_draft" : true,
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "state" : "draft",
    "update_available" : false,
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "version" : 1
  }, {
    "id" : "9c7afed6-17fb-4c56-a13d-440a78f936bd",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "region-eu-de-stage",
      "description" : "The stage `eu-de` configuration. A blueprint must be used to configure the Virtual Private Cloud and Red Hat OpenShift stage `eu-de`."
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/9c7afed6-17fb-4c56-a13d-440a78f936bd",
    "is_draft" : true,
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "state" : "draft",
    "update_available" : false,
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "version" : 1
  } ],
  "environments" : [ {
    "id" : "b0c44146-1ef6-40c2-82ba-74d51149770a",
    "definition" : {
      "name" : "dev-environment",
      "description" : "The development environment."
    },
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "created_at" : "2023-02-10T10:05:35.787Z",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/environments/b0c44146-1ef6-40c2-82ba-74d51149770a"
  } ],
  "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
  "cumulative_needs_attention_view" : [ {
    "event" : "project.instance.update"
  }, {
    "event_id" : "489f0090-6d7c-4af5-8f20-9106543e4974"
  }, {
    "config_id" : "069ab83e-5016-4bf2-bd50-cc95cf678293"
  }, {
    "config_version" : 1
  } ],
  "event_notifications_crn" : "crn:v1:staging:public:event-notifications:us-south:a/06580c923e40314421d3b6cb40c01c68:instance-id::",
  "location" : "us-south",
  "resource_group" : "Default",
  "resource_group_id" : "f37d2637ea814cfd9a1742683a713d24",
  "state" : "ready"
}

Chemin d'accès JMES par défaut

Chemin d'accès JMES par défaut
Réponse	Sortie	Requête
Réussite	Valeur par défaut
	Tableau	`{id: id, name: definition.name, state: state}`
Erreur	Valeur par défaut
	Tableau	`{id: id, name: definition.name, state: state}`
Toutes les pages	Valeur par défaut
	Tableau	`{id: id, name: definition.name, state: state}`

Si une requête JMESPath personnalisée est fournie, elle remplacera toute requête JMESPath figurant dans le tableau ci-dessus.

`ibmcloud project update`

Mettez à jour un projet en spécifiant son ID.

ibmcloud project update [--id ID] {--definition DEFINITION | --definition-name DEFINITION-NAME --definition-description DEFINITION-DESCRIPTION --definition-auto-deploy-mode DEFINITION-AUTO-DEPLOY-MODE --definition-monitoring-enabled=DEFINITION-MONITORING-ENABLED --definition-destroy-on-delete=DEFINITION-DESTROY-ON-DELETE --definition-store DEFINITION-STORE --definition-terraform-engine DEFINITION-TERRAFORM-ENGINE --definition-auto-deploy=DEFINITION-AUTO-DEPLOY} [--output FORMAT] [-q, --quiet]

Options de commande

--id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--definition (ProjectDefinitionPatch)

Définition du projet. Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition=@path/to/file.json.

--definition-name (chaîne)

La longueur maximale est de 128 caractères. La longueur minimale est de 1 caractères. La valeur doit correspondre à l'expression régulière /^(?!\\s)(?!.*\\s$)[^'"`\/<>{}\\x00-\\x1F]+$/.

--definition-description (chaîne)

La longueur maximale est de 1024 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.

--definition-auto-deploy-mode (chaîne)

Il s'agit d'un paramètre avancé du déploiement automatique qui indique comment le déploiement automatique doit se comporter lorsqu'il est activé. 2 options existent :

auto_approval approuvera automatiquement la configuration après validation sans confirmation de l'utilisateur.

manual_approval demandera la confirmation de l'utilisateur pour approuver la configuration après validation avant que le déploiement de la configuration ne commence. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

Les valeurs admises sont: auto_approval, manual_approval.

--definition-monitoring-enabled (bool)

--definition-destroy-on-delete (bool)

--definition-store (ProjectDefinitionStore)

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition-store=@path/to/file.json.

--definition-terraform-engine (ProjectTerraformEngineSettings)

Schéma expérimental - à des fins de prototypage. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

--definition-auto-deploy (bool)

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemples

ibmcloud project update \
    --id exampleString \
    --definition '{"name": "acme-microservice", "description": "A microservice to deploy on top of ACME infrastructure.", "auto_deploy_mode": "auto_approval", "monitoring_enabled": true, "destroy_on_delete": true, "store": {"type": "gh", "url": "exampleString", "token": "exampleString", "config_directory": "exampleString"}, "terraform_engine": {"id": "exampleString", "type": "terraform-enterprise"}, "auto_deploy": true}'

Des options granulaires sont également disponibles pour les sous-zones des options de chaîne JSON:

ibmcloud project update \
    --id exampleString \
    --definition-name exampleString \
    --definition-description exampleString \
    --definition-auto-deploy-mode auto_approval \
    --definition-monitoring-enabled=true \
    --definition-destroy-on-delete=true \
    --definition-store projectDefinitionStore \
    --definition-terraform-engine projectTerraformEngineSettings \
    --definition-auto-deploy=true

Exemple de sortie

Exemple de réponse pour l'extraction d'un projet avec des configurations.

{
  "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
  "created_at" : "2023-02-22T19:51:23.253Z",
  "modified_at" : "2023-02-22T19:51:23.253Z",
  "href" : "https://projects.service.url/v1/projects/cfbf901-ab8e-ac97-b01b-ab5af830be8a",
  "definition" : {
    "name" : "acme-microservice",
    "description" : "A microservice to deploy on top of ACME infrastructure.",
    "auto_deploy_mode" : "manual_approval",
    "auto_deploy" : false,
    "destroy_on_delete" : true,
    "monitoring_enabled" : false
  },
  "configs" : [ {
    "id" : "673d79e4-52bf-4184-b8e9-d3ca3c110f96",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "common-variables",
      "description" : "The common-variables configuration."
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/673d79e4-52bf-4184-b8e9-d3ca3c110f96",
    "is_draft" : true,
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "state" : "draft",
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "update_available" : false,
    "version" : 1
  }, {
    "id" : "4a1d4ba2-54ba-43a7-975a-d82b5a7612d1",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "account-stage",
      "description" : "The stage account configuration. The stage account hosts test environments prestage, performance, stage. This configuration configures services that are common to all these environments and regions. It's a `terraform_template` type of configuration that points to a GitHub repository that hosts the terraform modules that a Schematics workspace can deploy."
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/4a1d4ba2-54ba-43a7-975a-d82b5a7612d1",
    "is_draft" : true,
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "state" : "draft",
    "update_available" : false,
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "version" : 1
  }, {
    "id" : "293c3c36-a094-4115-a12b-de0a9ca39be5",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "env-stage",
      "description" : "The stage environment configuration. It includes services that are common to all the environment regions. A blueprint must be used to configure all the services that are common to the stage regions. It's a `terraform_template` type of configuration that points to a GitHub repository that hosts the Terraform modules that a Schematics workspace can deploy."
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/293c3c36-a094-4115-a12b-de0a9ca39be5",
    "is_draft" : true,
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "state" : "draft",
    "update_available" : false,
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "version" : 1
  }, {
    "id" : "596e8656-9d4b-41a5-8340-b0cbe8bd374a",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "region-us-south-stage",
      "description" : "The stage `us-south` configuration. A blueprint must be used to configure the Virtual Private Cloud and Red Hat OpenShift stage `us-south`."
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/596e8656-9d4b-41a5-8340-b0cbe8bd374a",
    "is_draft" : true,
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "state" : "draft",
    "update_available" : false,
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "version" : 1
  }, {
    "id" : "9c7afed6-17fb-4c56-a13d-440a78f936bd",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "region-eu-de-stage",
      "description" : "The stage `eu-de` configuration. A blueprint must be used to configure the Virtual Private Cloud and Red Hat OpenShift stage `eu-de`."
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/9c7afed6-17fb-4c56-a13d-440a78f936bd",
    "is_draft" : true,
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "state" : "draft",
    "update_available" : false,
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "version" : 1
  } ],
  "environments" : [ {
    "id" : "b0c44146-1ef6-40c2-82ba-74d51149770a",
    "definition" : {
      "name" : "dev-environment",
      "description" : "The development environment."
    },
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "created_at" : "2023-02-10T10:05:35.787Z",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/environments/b0c44146-1ef6-40c2-82ba-74d51149770a"
  } ],
  "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
  "cumulative_needs_attention_view" : [ {
    "event" : "project.instance.update"
  }, {
    "event_id" : "489f0090-6d7c-4af5-8f20-9106543e4974"
  }, {
    "config_id" : "069ab83e-5016-4bf2-bd50-cc95cf678293"
  }, {
    "config_version" : 1
  } ],
  "event_notifications_crn" : "crn:v1:staging:public:event-notifications:us-south:a/06580c923e40314421d3b6cb40c01c68:instance-id::",
  "location" : "us-south",
  "resource_group" : "Default",
  "resource_group_id" : "f37d2637ea814cfd9a1742683a713d24",
  "state" : "ready"
}

`ibmcloud project delete`

Supprimez un document de projet en spécifiant l'ID. Un projet ne peut être supprimé qu'après avoir supprimé toutes ses ressources.

ibmcloud project delete [--id ID] [--output FORMAT] [-q, --quiet]

Options de commande

--id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

Exemple

ibmcloud project delete \
    --id exampleString

Exemple de sortie

Exemple de réponse à une demande de suppression d'un projet.

{
  "id" : "4059955c-ccb3-4fd3-aa48-34e3b8334f80"
}

Environnements

Ressource Commandes pour les environnements.

`ibmcloud project environment-create`

Créez un environnement pour regrouper des configurations associées et partager des valeurs entre elles afin de faciliter le déploiement. Pour plus d'informations, voir Création d'un environnement.

ibmcloud project environment-create [--project-id PROJECT-ID] [--definition DEFINITION | --definition-description DEFINITION-DESCRIPTION --definition-name DEFINITION-NAME --definition-authorizations DEFINITION-AUTHORIZATIONS --definition-inputs DEFINITION-INPUTS --definition-compliance-profile DEFINITION-COMPLIANCE-PROFILE]

Options de commande

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--definition (EnvironmentDefinitionRequiredProperties)

Définition de l'environnement. Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition=@path/to/file.json.

--definition-description (chaîne)

La description de l'environnement. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

--definition-name (chaîne)

Nom de l'environnement. Il est unique au sein du compte dans les projets et les régions. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La longueur minimale est de 1 caractères. La valeur doit correspondre à l'expression régulière /^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]+$/.

--definition-authorizations (ProjectConfigAuth)

Détails de l'autorisation. Vous pouvez l'autoriser à l'aide d'un profil sécurisé ou d'une clé d'API dans Secrets Manager. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition-authorizations=@path/to/file.json.

--definition-inputs (mappe générique)

Variables d'entrée utilisées pour la définition de configuration et l'environnement. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition-inputs=@path/to/file.json.

--definition-compliance-profile (ProjectComplianceProfile)

Profil requis pour la conformité. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition-compliance-profile=@path/to/file.json.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemples

ibmcloud project environment-create \
    --project-id exampleString \
    --definition '{"description": "The environment development.", "name": "development", "authorizations": {"trusted_profile_id": "Profile-9ac10c5c-195c-41ef-b465-68a6b6dg5f12", "method": "trusted_profile", "api_key": "exampleString"}, "inputs": {"anyKey": "anyValue"}, "compliance_profile": {"id": "some-profile-id", "instance_id": "some-instance-id", "instance_location": "us-south", "attachment_id": "some-attachment-id", "profile_name": "some-profile-name", "wp_policy_id": "exampleString", "wp_instance_id": "exampleString", "wp_instance_name": "exampleString", "wp_instance_location": "us-south", "wp_zone_id": "exampleString", "wp_zone_name": "exampleString", "wp_policy_name": "exampleString"}}'

Des options granulaires sont également disponibles pour les sous-zones des options de chaîne JSON:

ibmcloud project environment-create \
    --project-id exampleString \
    --definition-description exampleString \
    --definition-name exampleString \
    --definition-authorizations projectConfigAuth \
    --definition-inputs '{"anyKey": "anyValue"}' \
    --definition-compliance-profile projectComplianceProfile

Exemple de sortie

Exemple de réponse d'environnement.

{
  "id" : "env123",
  "definition" : {
    "name" : "development",
    "description" : "The environment development.",
    "authorizations" : {
      "method" : "trusted_profile",
      "trusted_profile_id" : "Profile-9ac10c5c-195c-41ef-b465-68a6b6dg5f12"
    },
    "inputs" : {
      "resource_group" : "stage",
      "region" : "us-south"
    },
    "compliance_profile" : {
      "id" : "some-profile-id",
      "instance_id" : "some-instance-id",
      "instance_location" : "us-south",
      "profile_name" : "some-profile-name",
      "attachment_id" : "some-attachment-id"
    }
  },
  "project" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "iaas-infra-prestage-env"
    },
    "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "created_at" : "2023-06-29T03:28:14.709Z",
  "modified_at" : "2023-06-29T03:28:14.709Z",
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/6fd53106-7ce6-429e-8c57-f22e832d0c4b/environments/2102afed-94c7-46fe-90f2-7fff290637b4"
}

`ibmcloud project environments`

Répertorier tous les environnements disponibles. Pour plus d'informations, voir Création d'un environnement. Note : Si l'option --all-pages n'est pas activée, la commande ne récupérera qu'une seule page de la collection.

ibmcloud project environments [--project-id PROJECT-ID] [--token TOKEN] [--limit LIMIT] [--output FORMAT] [-q, --quiet]

Options de commande

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--token (chaîne)

Le serveur utilise ce paramètre pour déterminer la première entrée renvoyée sur la page suivante. Si ce paramètre n'est pas spécifié, la première page logique est renvoyée.

--limit (int64)

Le nombre maximum de ressources à renvoyer. Le nombre de ressources renvoyées est identique, à l'exception de la dernière page.

La valeur par défaut est 10. La valeur maximale est de 100. Valeur minimale : 1.

--all-pages (bool)

Invoquer plusieurs requêtes pour afficher toutes les pages de la collection pour les environnements.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemple

ibmcloud project environments \
    --project-id exampleString \
    --token exampleString \
    --limit 10

Exemple de sortie

Exemple de réponse d'environnement pour une liste.

{
  "limit" : 1,
  "first" : {
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/environments?limit=1"
  },
  "next" : {
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/environments?limit=1&token=da969bff-vf9q-3t1t-b677-d6rt5c0de54e"
  },
  "environments" : [ {
    "id" : "env123",
    "definition" : {
      "name" : "development",
      "description" : "The environment development.",
      "authorizations" : {
        "method" : "trusted_profile",
        "trusted_profile_id" : "Profile-9ac10c5c-195c-41ef-b465-68a6b6dg5f12"
      },
      "inputs" : {
        "resource_group" : "stage",
        "region" : "us-south"
      },
      "compliance_profile" : {
        "id" : "some-profile-id",
        "instance_id" : "some-instance-id",
        "instance_location" : "us-south",
        "profile_name" : "some-profile-name",
        "attachment_id" : "some-attachment-id"
      }
    },
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "created_at" : "2023-06-29T03:28:14.709Z",
    "modified_at" : "2023-06-29T03:28:14.709Z",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/6fd53106-7ce6-429e-8c57-f22e832d0c4b/environments/2102afed-94c7-46fe-90f2-7fff290637b4"
  } ]
}

`ibmcloud project environment`

Obtenez un environnement. En savoir plus.

ibmcloud project environment --id ID [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

Options de commande

--id (chaîne)

ID de l'environnement. Obligatoire.

La longueur maximale est de 256 caractères. La longueur minimale est de 1 caractères. La valeur doit correspondre à l'expression régulière /^(?!\\s)(?!.*\\s$).+$/.

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemple

ibmcloud project environment \
    --project-id exampleString \
    --id exampleString

Exemple de sortie

Exemple de réponse d'environnement.

{
  "id" : "env123",
  "definition" : {
    "name" : "development",
    "description" : "The environment development.",
    "authorizations" : {
      "method" : "trusted_profile",
      "trusted_profile_id" : "Profile-9ac10c5c-195c-41ef-b465-68a6b6dg5f12"
    },
    "inputs" : {
      "resource_group" : "stage",
      "region" : "us-south"
    },
    "compliance_profile" : {
      "id" : "some-profile-id",
      "instance_id" : "some-instance-id",
      "instance_location" : "us-south",
      "profile_name" : "some-profile-name",
      "attachment_id" : "some-attachment-id"
    }
  },
  "project" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "iaas-infra-prestage-env"
    },
    "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "created_at" : "2023-06-29T03:28:14.709Z",
  "modified_at" : "2023-06-29T03:28:14.709Z",
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/6fd53106-7ce6-429e-8c57-f22e832d0c4b/environments/2102afed-94c7-46fe-90f2-7fff290637b4"
}

`ibmcloud project environment-update`

Mettez à jour un environnement en spécifiant son ID. En savoir plus.

ibmcloud project environment-update [--project-id PROJECT-ID] --id ID [--definition DEFINITION | --definition-description DEFINITION-DESCRIPTION --definition-name DEFINITION-NAME --definition-authorizations DEFINITION-AUTHORIZATIONS --definition-inputs DEFINITION-INPUTS --definition-compliance-profile DEFINITION-COMPLIANCE-PROFILE] [--output FORMAT] [-q, --quiet]

Options de commande

--id (chaîne)

ID de l'environnement. Obligatoire.

La longueur maximale est de 256 caractères. La longueur minimale est de 1 caractères. La valeur doit correspondre à l'expression régulière /^(?!\\s)(?!.*\\s$).+$/.

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--definition (EnvironmentDefinitionPropertiesPatch)

Définition d'environnement utilisée pour les mises à jour. Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition=@path/to/file.json.

--definition-description (chaîne)

La description de l'environnement. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 1024 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.

--definition-name (chaîne)

La longueur maximale est de 128 caractères. La longueur minimale est de 1 caractères. La valeur doit correspondre à l'expression régulière /^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]+$/.

--definition-authorizations (ProjectConfigAuth)

--definition-inputs (mappe générique)

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition-inputs=@path/to/file.json.

--definition-compliance-profile (ProjectComplianceProfile)

Profil requis pour la conformité. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemples

ibmcloud project environment-update \
    --project-id exampleString \
    --id exampleString \
    --definition '{"description": "The environment development.", "name": "development", "authorizations": {"trusted_profile_id": "Profile-9ac10c5c-195c-41ef-b465-68a6b6dg5f12", "method": "trusted_profile", "api_key": "exampleString"}, "inputs": {"anyKey": "anyValue"}, "compliance_profile": {"id": "some-profile-id", "instance_id": "some-instance-id", "instance_location": "us-south", "attachment_id": "some-attachment-id", "profile_name": "some-profile-name", "wp_policy_id": "exampleString", "wp_instance_id": "exampleString", "wp_instance_name": "exampleString", "wp_instance_location": "us-south", "wp_zone_id": "exampleString", "wp_zone_name": "exampleString", "wp_policy_name": "exampleString"}}'

Des options granulaires sont également disponibles pour les sous-zones des options de chaîne JSON:

ibmcloud project environment-update \
    --project-id exampleString \
    --id exampleString \
    --definition-description exampleString \
    --definition-name exampleString \
    --definition-authorizations projectConfigAuth \
    --definition-inputs '{"anyKey": "anyValue"}' \
    --definition-compliance-profile projectComplianceProfile

Exemple de sortie

Exemple de réponse d'environnement.

{
  "id" : "env123",
  "definition" : {
    "name" : "development",
    "description" : "The environment development.",
    "authorizations" : {
      "method" : "trusted_profile",
      "trusted_profile_id" : "Profile-9ac10c5c-195c-41ef-b465-68a6b6dg5f12"
    },
    "inputs" : {
      "resource_group" : "stage",
      "region" : "us-south"
    },
    "compliance_profile" : {
      "id" : "some-profile-id",
      "instance_id" : "some-instance-id",
      "instance_location" : "us-south",
      "profile_name" : "some-profile-name",
      "attachment_id" : "some-attachment-id"
    }
  },
  "project" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "iaas-infra-prestage-env"
    },
    "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "created_at" : "2023-06-29T03:28:14.709Z",
  "modified_at" : "2023-06-29T03:28:14.709Z",
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/6fd53106-7ce6-429e-8c57-f22e832d0c4b/environments/2102afed-94c7-46fe-90f2-7fff290637b4"
}

`ibmcloud project environment-delete`

Supprimer un environnement dans un projet en spécifiant son ID.

ibmcloud project environment-delete --id ID [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

Options de commande

--id (chaîne)

ID de l'environnement. Obligatoire.

La longueur maximale est de 256 caractères. La longueur minimale est de 1 caractères. La valeur doit correspondre à l'expression régulière /^(?!\\s)(?!.*\\s$).+$/.

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemple

ibmcloud project environment-delete \
    --project-id exampleString \
    --id exampleString

Exemple de sortie

L'exemple de réponse de suppression de l'environnement.

{
  "id" : "env123"
}

Configurations

Commandes pour la ressource Configurations.

`ibmcloud project config-create`

Ajouter une nouvelle configuration à un projet.

ibmcloud project config-create [--project-id PROJECT-ID] [--definition DEFINITION | --definition-compliance-profile DEFINITION-COMPLIANCE-PROFILE --definition-locator-id DEFINITION-LOCATOR-ID --definition-members DEFINITION-MEMBERS --definition-uses DEFINITION-USES --definition-description DEFINITION-DESCRIPTION --definition-name DEFINITION-NAME --definition-authorizations DEFINITION-AUTHORIZATIONS --definition-inputs DEFINITION-INPUTS --definition-settings DEFINITION-SETTINGS --definition-environment-id DEFINITION-ENVIRONMENT-ID --definition-resource-crns DEFINITION-RESOURCE-CRNS] [--schematics SCHEMATICS | --schematics-workspace-crn SCHEMATICS-WORKSPACE-CRN] [--output FORMAT] [-q, --quiet]

Options de commande

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--definition (ProjectConfigDefinitionPrototype)

Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition=@path/to/file.json.

--schematics (SchematicsWorkspace)

Espace de travail Schematics à utiliser pour le déploiement de cette architecture déployable.

Si vous importez des données à partir d'un espace de travail Schematics existant qui n'est pas soutenu par un panier, un locator_id doit être fourni. Si vous utilisez un espace de travail Schematics qui est soutenu par un panier, un locator_id n'est pas nécessaire car l'espace de travail Schematics en possède un.

Il existe trois scénarios:

Si seul un locator_id est spécifié, un nouvel espace de travail Schematics est instancié avec ce locator_id.

Si seul un schéma workspace_crn est spécifié, un 400 est renvoyé si un locator_id est introuvable dans l'espace de travail schematics existant.

Si un Schematics workspace_crn et un locator_id sont spécifiés, un code 400 est renvoyé si le locator_id spécifié ne correspond pas au locator_id dans l'espace de travail Schematics existant.

Pour plus d'informations, voir Création d'espaces de travail et importation du modèle Terraform. Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --schematics=@path/to/file.json.

--definition-compliance-profile (ProjectComplianceProfile)

Profil requis pour la conformité. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

--definition-locator-id (chaîne)

Concaténation unique de l'ID catalogue et de l'ID version qui identifient l'architecture déployable dans le catalogue. En cas d'importation à partir d'un espace de travail Schematics existant qui n'est pas soutenu par un panier, un locator_id est nécessaire. Si vous utilisez un espace de travail Schematics qui est soutenu par un panier, un locator_id n'est pas nécessaire car l'espace de travail Schematics en possède un.

Il existe trois scénarios:

Si seul un locator_id est spécifié, un nouvel espace de travail Schematics est instancié avec ce locator_id.

Si seul un schéma workspace_crn est spécifié, un 400 est renvoyé si un locator_id est introuvable dans l'espace de travail schematics existant.

Si un Schematics workspace_crn et un locator_id sont spécifiés, un message 400 est renvoyé si le locator_id spécifié n'est pas en accord avec le locator_id dans l'espace de travail Schematics existant. Pour plus d'informations sur la création d'un espace de travail Schematics, voir Création d'espaces de travail et importation du modèle Terraform. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 512 caractères. La longueur minimale est de 1 caractères. La valeur doit correspondre à l'expression régulière /^(?!\\s)(?!.*\\s$)[\\.0-9a-z-A-Z_-]+$/.

--definition-members (StackMember[])

Les architectures déployables membres qui sont incluses dans la pile. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 100 éléments. La longueur minimale est de 0.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition-members=@path/to/file.json.

--definition-uses (ProjectConfigUses[])

Les architectures deployabe dépendantes qui sont référencées par cette configuration. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 100 éléments. La longueur minimale est de 0.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition-uses=@path/to/file.json.

--definition-description (chaîne)

Description de la configuration du projet. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

--definition-name (chaîne)

Nom de la configuration. Il est unique au sein du compte dans les projets et les régions. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La longueur minimale est de 1 caractères. La valeur doit correspondre à l'expression régulière /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.

--definition-authorizations (ProjectConfigAuth)

Détails de l'autorisation. Il peut s'autoriser en utilisant un profil de confiance ou une clé API sur Secrets Manager. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

--definition-inputs (mappe générique)

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition-inputs=@path/to/file.json.

--definition-settings (mappe générique)

Variables d'environnement Schematics à utiliser pour déployer la configuration. Les paramètres ne sont disponibles que s'ils sont spécifiés lors de la création initiale de la configuration. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition-settings=@path/to/file.json.

--definition-environment-id (chaîne)

L'ID de l'environnement du projet. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--definition-resource-crns (chaîne[])

Noms CRN des ressources associées à cette configuration. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

Les éléments de la liste doivent correspondre à l'expression régulière /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/. La longueur maximale est de 110 éléments. La longueur minimale est de 0.

--schematics-workspace-crn (chaîne)

Nom de ressource IBM Cloud qui identifie une ressource de manière unique. Cette option fournit une valeur pour une sous-zone de l'option JSON'schematics'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 512 caractères. La longueur minimale est de 4 caractères. La valeur doit correspondre à l'expression régulière /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemples

ibmcloud project config-create \
    --project-id exampleString \
    --definition '{"compliance_profile": {}, "locator_id": "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global", "members": [{"name": "exampleString", "config_id": "exampleString"}], "description": "The stage environment configuration.", "name": "env-stage", "authorizations": {"trusted_profile_id": "exampleString", "method": "exampleString", "api_key": "exampleString"}, "inputs": {"anyKey": "anyValue"}, "settings": {"anyKey": "anyValue"}, "environment_id": "exampleString"}' \
    --schematics '{"workspace_crn": "crn:v1:staging:public:project:us-south:a/4e1c48fcf8ac33c0a2441e4139f189ae:bf40ad13-b107-446a-8286-c6d576183bb1::"}'

Des options granulaires sont également disponibles pour les sous-zones des options de chaîne JSON:

ibmcloud project config-create \
    --project-id exampleString \
    --definition-compliance-profile projectComplianceProfile \
    --definition-locator-id exampleString \
    --definition-members '[stackMember]' \
    --definition-uses '[projectConfigUses]' \
    --definition-description exampleString \
    --definition-name exampleString \
    --definition-authorizations projectConfigAuth \
    --definition-inputs '{"anyKey": "anyValue"}' \
    --definition-settings '{"anyKey": "anyValue"}' \
    --definition-environment-id exampleString \
    --schematics-workspace-crn crn:v1:staging:public:project:us-south:a/4e1c48fcf8ac33c0a2441e4139f189ae:bf40ad13-b107-446a-8286-c6d576183bb1::

`ibmcloud project configs`

Extrayez la collection de configurations. Note : Si l'option --all-pages n'est pas activée, la commande ne récupérera qu'une seule page de la collection.

ibmcloud project configs [--project-id PROJECT-ID] [--token TOKEN] [--limit LIMIT] [--output FORMAT] [-q, --quiet]

Options de commande

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--token (chaîne)

Le serveur utilise ce paramètre pour déterminer la première entrée renvoyée sur la page suivante. Si ce paramètre n'est pas spécifié, la première page logique est renvoyée.

--limit (int64)

Le nombre maximum de ressources à renvoyer. Le nombre de ressources renvoyées est identique, à l'exception de la dernière page.

La valeur par défaut est 10. La valeur maximale est de 100. Valeur minimale : 1.

--all-pages (bool)

Invoquer plusieurs requêtes pour afficher toutes les pages de la collection pour les configurations.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemple

ibmcloud project configs \
    --project-id exampleString \
    --token exampleString \
    --limit 10

Exemple de sortie

Exemple de réponse à une demande d'obtention de configurations de projet.

{
  "limit" : 2,
  "first" : {
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs?limit=2"
  },
  "next" : {
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs?limit=2&token=da969bff-vf9q-3t1t-b677-d6rt5c0de54e"
  },
  "configs" : [ {
    "id" : "293c3c36-a094-4115-a12b-de0a9ca39be5",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "env-stage",
      "description" : "The stage environment configuration."
    },
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "version" : 1,
    "state" : "validated",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/db268db0-160b-4911-8f93-89659000a927/configs/293c3c36-a094-4115-a12b-de0a9ca39be5"
  }, {
    "id" : "9c7afed6-17fb-4c56-a13d-440a78f936bd",
    "deployment_model" : "project_deployed",
    "definition" : {
      "name" : "region-eu-de-stage",
      "description" : "The stage `eu-de` configuration."
    },
    "approved_version" : {
      "definition" : {
        "locator_id" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global"
      },
      "version" : 1,
      "state" : "approved",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/db268db0-160b-4911-8f93-89659000a927/configs/9c7afed6-17fb-4c56-a13d-440a78f936bd/versions/1"
    },
    "project" : {
      "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
      "definition" : {
        "name" : "iaas-infra-prestage-env"
      },
      "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
      "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
    },
    "version" : 2,
    "state" : "draft",
    "created_at" : "2023-02-22T19:51:23.253Z",
    "modified_at" : "2023-02-22T19:51:23.253Z",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/db268db0-160b-4911-8f93-89659000a927/configs/9c7afed6-17fb-4c56-a13d-440a78f936bd"
  } ]
}

Chemin d'accès JMES par défaut

Chemin d'accès JMES par défaut
Réponse	Sortie	Requête
Réussite	Valeur par défaut
	Tableau	`configs[].{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`
Erreur	Valeur par défaut
	Tableau	`configs[].{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`
Toutes les pages	Valeur par défaut
	Tableau	`configs[].{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`

Si une requête JMESPath personnalisée est fournie, elle remplacera toute requête JMESPath figurant dans le tableau ci-dessus.

`ibmcloud project config`

Extraire la configuration de projet spécifiée dans un projet spécifique.

ibmcloud project config --id ID [--project-id PROJECT-ID] [--output FORMAT] [-q,--quiet]

Options de commande

--id (chaîne)

ID de configuration unique. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

Exemple

ibmcloud project config \
    --project-id exampleString \
    --id exampleString

Chemin d'accès JMES par défaut

Chemin d'accès JMES par défaut
Réponse	Sortie	Requête
Réussite	Valeur par défaut
	Tableau	`{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`
Erreur	Valeur par défaut
	Tableau	`{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`
Toutes les pages	Valeur par défaut
	Tableau	`{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`

Si une requête JMESPath personnalisée est fournie, elle remplacera toute requête JMESPath figurant dans le tableau ci-dessus.

`ibmcloud project config-update`

Mettez à jour une configuration dans un projet en spécifiant l'ID. En savoir plus.

ibmcloud project config-update --id ID {--definition DEFINITION | --definition-compliance-profile DEFINITION-COMPLIANCE-PROFILE --definition-locator-id DEFINITION-LOCATOR-ID --definition-members DEFINITION-MEMBERS --definition-uses DEFINITION-USES --definition-description DEFINITION-DESCRIPTION --definition-name DEFINITION-NAME --definition-authorizations DEFINITION-AUTHORIZATIONS --definition-inputs DEFINITION-INPUTS --definition-settings DEFINITION-SETTINGS --definition-environment-id DEFINITION-ENVIRONMENT-ID --definition-resource-crns DEFINITION-RESOURCE-CRNS} [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

Options de commande

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--id (chaîne)

ID de configuration unique. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--definition (ProjectConfigDefinitionPatch)

Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition=@path/to/file.json.

--definition-compliance-profile (ProjectComplianceProfile)

Profil requis pour la conformité. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

--definition-locator-id (chaîne)

Il existe trois scénarios:

Si seul un locator_id est spécifié, un nouvel espace de travail Schematics est instancié avec ce locator_id.

Si seul un schéma workspace_crn est spécifié, un 400 est renvoyé si un locator_id est introuvable dans l'espace de travail schematics existant.

Si un Schematics workspace_crn et un locator_id sont spécifiés, un message 400 est renvoyé si le locator_id spécifié n'est pas en accord avec le locator_id dans l'espace de travail Schematics existant. Pour plus d'informations sur la création d'un espace de travail Schematics, voir Création d'espaces de travail et importation du modèle Terraform. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 512 caractères. La longueur minimale est de 1 caractères. La valeur doit correspondre à l'expression régulière /^(?!\\s)(?!.*\\s$)[\\.0-9a-z-A-Z_-]+$/.

--definition-members (StackMember[])

La longueur maximale est de 100 éléments. La longueur minimale est de 0.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition-members=@path/to/file.json.

--definition-uses (ProjectConfigUses[])

La longueur maximale est de 100 éléments. La longueur minimale est de 0.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition-uses=@path/to/file.json.

--definition-description (chaîne)

Description de la configuration du projet. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 1024 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.

--definition-name (chaîne)

La longueur maximale est de 128 caractères. La longueur minimale est de 1 caractères. La valeur doit correspondre à l'expression régulière /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.

--definition-authorizations (ProjectConfigAuth)

--definition-inputs (mappe générique)

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition-inputs=@path/to/file.json.

--definition-settings (mappe générique)

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition-settings=@path/to/file.json.

--definition-environment-id (chaîne)

L'ID de l'environnement du projet. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--definition-resource-crns (chaîne[])

Noms CRN des ressources associées à cette configuration. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemples

ibmcloud project config-update \
    --project-id exampleString \
    --id exampleString \
    --definition '{"compliance_profile": {}, "locator_id": "exampleString", "members": [{"name": "exampleString", "config_id": "exampleString"}], "description": "exampleString", "name": "env-stage", "authorizations": {"trusted_profile_id": "exampleString", "method": "exampleString", "api_key": "exampleString"}, "inputs": {"anyKey": "anyValue"}, "settings": {"anyKey": "anyValue"}, "environment_id": "exampleString"}'

Des options granulaires sont également disponibles pour les sous-zones des options de chaîne JSON:

ibmcloud project config-update \
    --project-id exampleString \
    --id exampleString \
    --definition-compliance-profile projectComplianceProfile \
    --definition-locator-id exampleString \
    --definition-members '[stackMember]' \
    --definition-uses '[projectConfigUses]' \
    --definition-description exampleString \
    --definition-name exampleString \
    --definition-authorizations projectConfigAuth \
    --definition-inputs '{"anyKey": "anyValue"}' \
    --definition-settings '{"anyKey": "anyValue"}' \
    --definition-environment-id exampleString

`ibmcloud project config-delete`

Supprimer une configuration dans un projet en spécifiant son ID.

ibmcloud project config-delete --id ID [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

Options de commande

--id (chaîne)

ID de configuration unique. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

Exemple

ibmcloud project config-delete \
    --project-id exampleString \
    --id exampleString

Exemple de sortie

Exemple de réponse à une demande de suppression d'une configuration.

{
  "id" : "293c3c36-a094-4115-a12b-de0a9ca39be5"
}

`ibmcloud project config-force-approve`

Forcer l'approbation des modifications de la configuration principale avec un commentaire d'approbation.

ibmcloud project config-force-approve --id ID --comment COMMENT [--project-id PROJECT-ID]

Options de commande

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--id (chaîne)

ID de configuration unique. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--comment (chaîne)

Notes sur l'action de brouillon de projet. Si cette action est une approbation forcée du projet de configuration, elle doit inclure un commentaire non vide. Obligatoire.

La longueur maximale est de 1024 caractères. La longueur minimale est de 1 caractères. La valeur doit correspondre à l'expression régulière /^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]+$/.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemple

ibmcloud project config-force-approve \
    --project-id exampleString \
    --id exampleString \
    --comment 'Approving the changes'

Exemple de sortie

Exemple de réponse à une demande de brouillon de configuration d'architecture déployable.

{
  "id" : "293c3c36-a094-4115-a12b-de0a9ca39be5",
  "definition" : {
    "name" : "env-stage",
    "description" : "The stage environment configuration.",
    "locator_id" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global",
    "inputs" : {
      "account_id" : "ref:/configs/account-stage/inputs/account_id",
      "resource_group" : "stage",
      "access_tags" : [ "env:stage" ],
      "logdna_name" : "The name of the LogDNA stage service instance.",
      "sysdig_name" : "The name of the SysDig stage service instance."
    }
  },
  "is_draft" : true,
  "version" : 2,
  "outputs" : [ {
    "name" : "resource_group_id"
  }, {
    "name" : "logdna_id"
  }, {
    "name" : "sysdig_id"
  } ],
  "project" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "iaas-infra-prestage-env"
    },
    "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "schematics" : {
    "workspace_crn" : "crn:v1:staging:public:schematics:us-south:a/38acaf4469814090a4e675dc0c317a0d:95ad49de-ab96-4e7d-a08c-45c38aa448e6:workspace:us-south.workspace.service.e0106139"
  },
  "state" : "validated",
  "update_available" : true,
  "needs_attention_state" : [ ],
  "created_at" : "2023-02-22T19:51:23.253Z",
  "modified_at" : "2023-02-22T19:51:23.253Z",
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/b0c44146-1ef6-40c2-82ba-74d51149770a",
  "deployment_model" : "project_deployed",
  "references" : { }
}

`ibmcloud project config-approve`

Approuver et fusionner les modifications apportées à la configuration principale.

ibmcloud project config-approve --id ID --comment COMMENT [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

Options de commande

--id (chaîne)

ID de configuration unique. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--comment (chaîne)

Notes sur l'action de brouillon de projet. Si cette action est une approbation forcée du projet de configuration, elle doit inclure un commentaire non vide.

La longueur maximale est de 1024 caractères. La longueur minimale est de 1 caractères. La valeur doit correspondre à l'expression régulière /^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]+$/.

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemple

ibmcloud project config-approve \
    --project-id exampleString \
    --id exampleString \
    --comment 'Approving the changes'

Exemple de sortie

Exemple de réponse à une demande de brouillon de configuration d'architecture déployable.

{
  "id" : "293c3c36-a094-4115-a12b-de0a9ca39be5",
  "definition" : {
    "name" : "env-stage",
    "description" : "The stage environment configuration.",
    "locator_id" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global",
    "inputs" : {
      "account_id" : "ref:/configs/account-stage/inputs/account_id",
      "resource_group" : "stage",
      "access_tags" : [ "env:stage" ],
      "logdna_name" : "The name of the LogDNA stage service instance.",
      "sysdig_name" : "The name of the SysDig stage service instance."
    }
  },
  "is_draft" : true,
  "version" : 2,
  "outputs" : [ {
    "name" : "resource_group_id"
  }, {
    "name" : "logdna_id"
  }, {
    "name" : "sysdig_id"
  } ],
  "project" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "iaas-infra-prestage-env"
    },
    "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "schematics" : {
    "workspace_crn" : "crn:v1:staging:public:schematics:us-south:a/38acaf4469814090a4e675dc0c317a0d:95ad49de-ab96-4e7d-a08c-45c38aa448e6:workspace:us-south.workspace.service.e0106139"
  },
  "state" : "validated",
  "update_available" : true,
  "needs_attention_state" : [ ],
  "created_at" : "2023-02-22T19:51:23.253Z",
  "modified_at" : "2023-02-22T19:51:23.253Z",
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/b0c44146-1ef6-40c2-82ba-74d51149770a",
  "deployment_model" : "project_deployed",
  "references" : { }
}

`ibmcloud project config-validate`

Exécutez une vérification de validation sur une configuration spécifique du projet. La vérification inclut la création ou la mise à jour de l'espace de travail Schematics associé avec un travail de plan, l'exécution des analyses CRA et l'estimation des coûts.

ibmcloud project config-validate --id ID [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

Options de commande

--id (chaîne)

ID de configuration unique. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemple

ibmcloud project config-validate \
    --project-id exampleString \
    --id exampleString

Exemple de sortie

Exemple de réponse à une demande de brouillon de configuration d'architecture déployable.

{
  "id" : "293c3c36-a094-4115-a12b-de0a9ca39be5",
  "definition" : {
    "name" : "env-stage",
    "description" : "The stage environment configuration.",
    "locator_id" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global",
    "inputs" : {
      "account_id" : "ref:/configs/account-stage/inputs/account_id",
      "resource_group" : "stage",
      "access_tags" : [ "env:stage" ],
      "logdna_name" : "The name of the LogDNA stage service instance.",
      "sysdig_name" : "The name of the SysDig stage service instance."
    }
  },
  "is_draft" : true,
  "version" : 2,
  "outputs" : [ {
    "name" : "resource_group_id"
  }, {
    "name" : "logdna_id"
  }, {
    "name" : "sysdig_id"
  } ],
  "project" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "iaas-infra-prestage-env"
    },
    "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "schematics" : {
    "workspace_crn" : "crn:v1:staging:public:schematics:us-south:a/38acaf4469814090a4e675dc0c317a0d:95ad49de-ab96-4e7d-a08c-45c38aa448e6:workspace:us-south.workspace.service.e0106139"
  },
  "state" : "validated",
  "update_available" : true,
  "needs_attention_state" : [ ],
  "created_at" : "2023-02-22T19:51:23.253Z",
  "modified_at" : "2023-02-22T19:51:23.253Z",
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/b0c44146-1ef6-40c2-82ba-74d51149770a",
  "deployment_model" : "project_deployed",
  "references" : { }
}

`ibmcloud project config-prevalidate`

Exécute un contrôle de validation d'une configuration transmise via l'API. Le contrôle comprend la création d'un espace de travail Schematics avec une tâche de planification, l'exécution des analyses de l'ARC et l'estimation des coûts.

ibmcloud project config-prevalidate --id ID [--project-id PROJECT-ID] {--definition DEFINITION | --definition-compliance-profile DEFINITION-COMPLIANCE-PROFILE --definition-locator-id DEFINITION-LOCATOR-ID --definition-members DEFINITION-MEMBERS --definition-uses DEFINITION-USES --definition-description DEFINITION-DESCRIPTION --definition-name DEFINITION-NAME --definition-authorizations DEFINITION-AUTHORIZATIONS --definition-inputs DEFINITION-INPUTS --definition-settings DEFINITION-SETTINGS --definition-environment-id DEFINITION-ENVIRONMENT-ID --definition-resource-crns DEFINITION-RESOURCE-CRNS} [--schematics SCHEMATICS | --schematics-workspace-crn SCHEMATICS-WORKSPACE-CRN] [--output FORMAT] [-q, --quiet]

Options de commande

--id (chaîne)

ID de configuration unique. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--definition (ProjectConfigDefinitionPrototype)

Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition=@path/to/file.json.

--schematics (SchematicsWorkspace)

Espace de travail Schematics à utiliser pour le déploiement de cette architecture déployable.

Si vous importez des données à partir d'un espace de travail Schematics existant qui n'est pas soutenu par un panier, un locator_id doit être fourni. Si vous utilisez un espace de travail Schematics qui est soutenu par un panier, un locator_id n'est pas nécessaire car l'espace de travail Schematics en possède un.

Il existe trois scénarios:

Si seul un locator_id est spécifié, un nouvel espace de travail Schematics est instancié avec ce locator_id.

Si seul un schéma workspace_crn est spécifié, un 400 est renvoyé si un locator_id est introuvable dans l'espace de travail schematics existant.

Si un Schematics workspace_crn et un locator_id sont spécifiés, un code 400 est renvoyé si le locator_id spécifié ne correspond pas au locator_id dans l'espace de travail Schematics existant.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --schematics=@path/to/file.json.

--definition-compliance-profile (ProjectComplianceProfile)

Profil requis pour la conformité. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

--definition-locator-id (chaîne)

Il existe trois scénarios:

Si seul un locator_id est spécifié, un nouvel espace de travail Schematics est instancié avec ce locator_id.

Si seul un schéma workspace_crn est spécifié, un 400 est renvoyé si un locator_id est introuvable dans l'espace de travail schematics existant.

Si un Schematics workspace_crn et un locator_id sont spécifiés, un message 400 est renvoyé si le locator_id spécifié n'est pas en accord avec le locator_id dans l'espace de travail Schematics existant. Pour plus d'informations sur la création d'un espace de travail Schematics, voir Création d'espaces de travail et importation du modèle Terraform. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 512 caractères. La longueur minimale est de 1 caractères. La valeur doit correspondre à l'expression régulière /^(?!\\s)(?!.*\\s$)[\\.0-9a-z-A-Z_-]+$/.

--definition-members (StackMember[])

La longueur maximale est de 100 éléments. La longueur minimale est de 0.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition-members=@path/to/file.json.

--definition-uses (ProjectConfigUses[])

La longueur maximale est de 100 éléments. La longueur minimale est de 0.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition-uses=@path/to/file.json.

--definition-description (chaîne)

Description de la configuration du projet. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

--definition-name (chaîne)

La longueur maximale est de 128 caractères. La longueur minimale est de 1 caractères. La valeur doit correspondre à l'expression régulière /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.

--definition-authorizations (ProjectConfigAuth)

--definition-inputs (mappe générique)

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition-inputs=@path/to/file.json.

--definition-settings (mappe générique)

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --definition-settings=@path/to/file.json.

--definition-environment-id (chaîne)

L'ID de l'environnement du projet. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--definition-resource-crns (chaîne[])

Noms CRN des ressources associées à cette configuration. Cette option fournit une valeur pour une sous-zone de l'option JSON'definition'. Elle est mutuellement exclusive avec cette option.

--schematics-workspace-crn (chaîne)

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemples

ibmcloud project config-prevalidate \
    --project-id exampleString \
    --id exampleString \
    --definition '{"compliance_profile": {}, "locator_id": "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global", "members": [{"name": "exampleString", "config_id": "exampleString"}], "description": "The stage environment configuration.", "name": "env-stage", "authorizations": {"trusted_profile_id": "exampleString", "method": "exampleString", "api_key": "exampleString"}, "inputs": {"anyKey": "anyValue"}, "settings": {"anyKey": "anyValue"}, "environment_id": "exampleString"}' \
    --schematics '{"workspace_crn": "crn:v1:staging:public:project:us-south:a/4e1c48fcf8ac33c0a2441e4139f189ae:bf40ad13-b107-446a-8286-c6d576183bb1::"}'

Des options granulaires sont également disponibles pour les sous-zones des options de chaîne JSON:

ibmcloud project config-prevalidate \
    --project-id exampleString \
    --id exampleString \
    --definition-compliance-profile projectComplianceProfile \
    --definition-locator-id exampleString \
    --definition-members '[stackMember]' \
    --definition-uses '[projectConfigUses]' \
    --definition-description exampleString \
    --definition-name exampleString \
    --definition-authorizations projectConfigAuth \
    --definition-inputs '{"anyKey": "anyValue"}' \
    --definition-settings '{"anyKey": "anyValue"}' \
    --definition-environment-id exampleString \
    --schematics-workspace-crn crn:v1:staging:public:project:us-south:a/4e1c48fcf8ac33c0a2441e4139f189ae:bf40ad13-b107-446a-8286-c6d576183bb1::

Exemple de sortie

L'objet de résultat pour la prévalidation.

{
  "result_id" : "293c3c36-a094-4115-a12b-de0a9ca39be5"
}

`ibmcloud project get-prevalidate`

Récupérer les résultats de la prévalidation à l'aide d'une clé.

ibmcloud project get-prevalidate --id ID --result-id RESULT-ID [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

Options de commande

--id (chaîne)

ID de configuration unique. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--result-id (chaîne)

L'identifiant unique pour obtenir les événements prévalidés. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemple

ibmcloud project get-prevalidate \
    --project-id exampleString \
    --id exampleString \
    --result-id exampleString

Exemple de sortie

Un exemple de réponse pour obtenir des résultats prévalidés.

{
  "cost_estimate" : { },
  "cra_logs" : {
    "cra_version" : "2.0.4",
    "status" : "passed"
  },
  "job" : {
    "id" : "ba98208b61efa490153b72adfd672251",
    "summary" : {
      "version" : "1.0.5",
      "plan_summary" : { },
      "apply_summary" : { },
      "destroy_summary" : { },
      "message_summary" : { },
      "plan_messages" : { },
      "apply_messages" : { },
      "destroy_messages" : { }
    }
  },
  "result" : "succeeded"
}

`ibmcloud project config-deploy`

Déployez la configuration d'un projet. Cette opération est asynchrone et peut être suivie en utilisant l'API "get project configuration" avec toutes les métadonnées.

ibmcloud project config-deploy --id ID [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

Options de commande

--id (chaîne)

ID de configuration unique. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemple

ibmcloud project config-deploy \
    --project-id exampleString \
    --id exampleString

Exemple de sortie

Exemple de réponse à une demande de brouillon de configuration d'architecture déployable.

{
  "id" : "293c3c36-a094-4115-a12b-de0a9ca39be5",
  "definition" : {
    "name" : "env-stage",
    "description" : "The stage environment configuration.",
    "locator_id" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global",
    "inputs" : {
      "account_id" : "ref:/configs/account-stage/inputs/account_id",
      "resource_group" : "stage",
      "access_tags" : [ "env:stage" ],
      "logdna_name" : "The name of the LogDNA stage service instance.",
      "sysdig_name" : "The name of the SysDig stage service instance."
    }
  },
  "is_draft" : true,
  "version" : 2,
  "outputs" : [ {
    "name" : "resource_group_id"
  }, {
    "name" : "logdna_id"
  }, {
    "name" : "sysdig_id"
  } ],
  "project" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "iaas-infra-prestage-env"
    },
    "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "schematics" : {
    "workspace_crn" : "crn:v1:staging:public:schematics:us-south:a/38acaf4469814090a4e675dc0c317a0d:95ad49de-ab96-4e7d-a08c-45c38aa448e6:workspace:us-south.workspace.service.e0106139"
  },
  "state" : "validated",
  "update_available" : true,
  "needs_attention_state" : [ ],
  "created_at" : "2023-02-22T19:51:23.253Z",
  "modified_at" : "2023-02-22T19:51:23.253Z",
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/b0c44146-1ef6-40c2-82ba-74d51149770a",
  "deployment_model" : "project_deployed",
  "references" : { }
}

`ibmcloud project config-undeploy`

Annuler le déploiement des ressources de configuration d'un projet. L'opération annule le déploiement de toutes les ressources déployées avec la configuration spécifique. Les ressources de configuration peuvent être suivies en utilisant l'API "get project configuration" avec des métadonnées complètes.

ibmcloud project config-undeploy --id ID [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

Options de commande

--id (chaîne)

ID de configuration unique. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemple

ibmcloud project config-undeploy \
    --project-id exampleString \
    --id exampleString

Exemple de sortie

Exemple de réponse à une demande de brouillon de configuration d'architecture déployable.

{
  "id" : "293c3c36-a094-4115-a12b-de0a9ca39be5",
  "definition" : {
    "name" : "env-stage",
    "description" : "The stage environment configuration.",
    "locator_id" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global",
    "inputs" : {
      "account_id" : "ref:/configs/account-stage/inputs/account_id",
      "resource_group" : "stage",
      "access_tags" : [ "env:stage" ],
      "logdna_name" : "The name of the LogDNA stage service instance.",
      "sysdig_name" : "The name of the SysDig stage service instance."
    }
  },
  "is_draft" : true,
  "version" : 2,
  "outputs" : [ {
    "name" : "resource_group_id"
  }, {
    "name" : "logdna_id"
  }, {
    "name" : "sysdig_id"
  } ],
  "project" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "iaas-infra-prestage-env"
    },
    "crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "schematics" : {
    "workspace_crn" : "crn:v1:staging:public:schematics:us-south:a/38acaf4469814090a4e675dc0c317a0d:95ad49de-ab96-4e7d-a08c-45c38aa448e6:workspace:us-south.workspace.service.e0106139"
  },
  "state" : "validated",
  "update_available" : true,
  "needs_attention_state" : [ ],
  "created_at" : "2023-02-22T19:51:23.253Z",
  "modified_at" : "2023-02-22T19:51:23.253Z",
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/configs/b0c44146-1ef6-40c2-82ba-74d51149770a",
  "deployment_model" : "project_deployed",
  "references" : { }
}

`ibmcloud project config-sync`

Synchronisez une configuration de projet en analysant les exécutions de pipeline associées et les journaux de l'espace de travail Schematics pour rétablir l'état opérationnel de la configuration.

ibmcloud project config-sync --id ID [--schematics SCHEMATICS | --schematics-workspace-crn SCHEMATICS-WORKSPACE-CRN] [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

Options de commande

--id (chaîne)

ID de configuration unique. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--schematics (SchematicsWorkspace)

Espace de travail Schematics à utiliser pour le déploiement de cette architecture déployable.

Si vous importez des données à partir d'un espace de travail Schematics existant qui n'est pas soutenu par un panier, un locator_id doit être fourni. Si vous utilisez un espace de travail Schematics qui est soutenu par un panier, un locator_id n'est pas nécessaire car l'espace de travail Schematics en possède un.

Il existe trois scénarios:

Si seul un locator_id est spécifié, un nouvel espace de travail Schematics est instancié avec ce locator_id.

Si seul un schéma workspace_crn est spécifié, un 400 est renvoyé si un locator_id est introuvable dans l'espace de travail schematics existant.

Si un Schematics workspace_crn et un locator_id sont spécifiés, un code 400 est renvoyé si le locator_id spécifié ne correspond pas au locator_id dans l'espace de travail Schematics existant.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --schematics=@path/to/file.json.

--schematics-workspace-crn (chaîne)

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemples

ibmcloud project config-sync \
    --project-id exampleString \
    --id exampleString \
    --schematics '{"workspace_crn": "crn:v1:staging:public:schematics:us-south:a/38acaf4469814090a4e675dc0c317a0d:95ad49de-ab96-4e7d-a08c-45c38aa448e6:workspace:us-south.workspace.service.e0106139"}'

Des options granulaires sont également disponibles pour les sous-zones des options de chaîne JSON:

ibmcloud project config-sync \
    --project-id exampleString \
    --id exampleString \
    --schematics-workspace-crn crn:v1:staging:public:project:us-south:a/4e1c48fcf8ac33c0a2441e4139f189ae:bf40ad13-b107-446a-8286-c6d576183bb1::

`ibmcloud project config-resources`

Répertorie les ressources déployées par une configuration.

ibmcloud project config-resources --project-id PROJECT-ID --id ID

Options de commande

--id (chaîne)

ID de configuration unique. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemple

ibmcloud project config-resources \
    --project-id exampleString \
    --id exampleString

Exemple de sortie

Exemple de réponse à une demande d'obtention de ressources de configuration de projet.

{
  "resources" : [ {
    "resource_crn" : "crn:v1:staging:public:toolchain:us-south:a/4e1c48fcf8ac33c0a2441e4139f189ae:bf40ad13-b107-446a-8286-c6d576183bb1::",
    "resource_name" : "toolchain_instance",
    "resource_type" : "ibm_cd_toolchain",
    "resource_tainted" : false,
    "resource_group_name" : "",
    "account_id" : "499b176abb3e1c9727df87ae48b27c7b",
    "location" : "us-south",
    "resource_status" : "active",
    "tags" : [ ],
    "service_tags" : [ ],
    "catalog_tags" : [ ]
  }, {
    "resource_crn" : "crn:v1:staging:public:cloud-object-storage:global:a/4e1c48fcf8ac33c0a2441e4139f189ae:bf40ad13-b107-446a-8286-c6d576183bb1::",
    "resource_name" : "cos_bucket_instance",
    "resource_type" : "ibm_cos_bucket",
    "resource_tainted" : false,
    "resource_group_name" : "",
    "account_id" : "499b176abb3e1c9727df87ae48b27c7b",
    "location" : "us-south",
    "resource_status" : "active",
    "tags" : [ ],
    "service_tags" : [ ],
    "catalog_tags" : [ ]
  } ],
  "resources_count" : 2
}

`ibmcloud project stack-definition-create`

Définit les entrées au niveau de la pile que les utilisateurs doivent configurer avec les valeurs d'entrée au niveau du membre. Ces valeurs sont incluses dans l'entrée du catalogue lorsque la pile d'architecture déployable est exportée vers un catalogue privé et sont nécessaires au déploiement de la pile d'architecture déployable. Une référence peut être ajoutée à une valeur, ou ajouter la valeur explicitement au niveau du membre.

ibmcloud project stack-definition-create --id ID {--stack-definition STACK-DEFINITION | --stack-definition-inputs STACK-DEFINITION-INPUTS --stack-definition-outputs STACK-DEFINITION-OUTPUTS} [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

Options de commande

--id (chaîne)

ID de configuration unique. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--stack-definition (StackDefinitionBlockPrototype)

Bloc de définition d'une définition de pile. Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --stack-definition=@path/to/file.json.

--stack-definition-inputs (StackDefinitionInputVariable[])

Définit les entrées que les utilisateurs doivent configurer au niveau de la pile. Ces entrées sont incluses dans l'entrée de catalogue lorsque la pile d'architecture déployable est exportée vers un catalogue privé. Cette option fournit une valeur pour une sous-zone de l'option JSON'stack-definition'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 300 éléments. La longueur minimale est de 0.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --stack-definition-inputs=@path/to/file.json.

--stack-definition-outputs (StackDefinitionOutputVariable[])

Sorties associées à cette définition de pile. Cette option fournit une valeur pour une sous-zone de l'option JSON'stack-definition'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 100 éléments. La longueur minimale est de 0.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --stack-definition-outputs=@path/to/file.json.

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemples

ibmcloud project stack-definition-create \
    --project-id exampleString \
    --id exampleString \
    --stack-definition '{"inputs": [{"name": "region", "type": "string", "description": "The IBM Cloud location where a resource is deployed.", "default": "us-south", "required": true, "hidden": false}], "outputs": [{"name": "vpc_cluster_id", "value": "cluster_id"}]}'

Des options granulaires sont également disponibles pour les sous-zones des options de chaîne JSON:

ibmcloud project stack-definition-create \
    --project-id exampleString \
    --id exampleString \
    --stack-definition-inputs '[stackDefinitionInputVariable]' \
    --stack-definition-outputs '[stackDefinitionOutputVariable]'

Exemple de sortie

Exemple de réponse d'une opération de création de modèle de pile.

{
  "id" : "293c3c36-a094-4115-a12b-de0a9ca6678a",
  "stack_definition" : {
    "inputs" : [ {
      "name" : "region",
      "type" : "string",
      "required" : true,
      "default" : "us-south",
      "hidden" : false,
      "description" : "The IBM Cloud location where a resource is deployed."
    }, {
      "name" : "resource_group",
      "type" : "string",
      "default" : "Default",
      "required" : true,
      "hidden" : false,
      "description" : "The IBM Cloud resource group where a resource is deployed."
    } ],
    "outputs" : [ {
      "name" : "vpc_cluster_id",
      "value" : "cluster_id"
    } ],
    "members" : [ {
      "name" : "foundation-deployable-architecture",
      "version_locator" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global",
      "inputs" : [ {
        "name" : "region",
        "value" : "us-south"
      }, {
        "name" : "cluster_name",
        "value" : "foundation-cluster"
      } ]
    }, {
      "name" : "middleware-architecture",
      "version_locator" : "01e1a9ad-534b-4ab9-996a-b8f2a8653d5c.4d86732e-04b9-4dab-bfdc-5b514d86ecd8",
      "inputs" : [ {
        "name" : "kube_version",
        "value" : 1.29
      } ]
    } ]
  },
  "created_at" : "2023-02-22T19:51:23.253Z",
  "modified_at" : "2023-02-22T19:51:23.253Z",
  "configuration" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "stack-bottom-up-example"
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/template",
  "references" : { }
}

`ibmcloud project stack-definition`

Extrayez la définition de pile associée à la configuration.

ibmcloud project stack-definition --id ID [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

Options de commande

--id (chaîne)

ID de configuration unique. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemple

ibmcloud project stack-definition \
    --project-id exampleString \
    --id exampleString

Exemple de sortie

Exemple de réponse d'une opération de création de modèle de pile.

{
  "id" : "293c3c36-a094-4115-a12b-de0a9ca6678a",
  "stack_definition" : {
    "inputs" : [ {
      "name" : "region",
      "type" : "string",
      "required" : true,
      "default" : "us-south",
      "hidden" : false,
      "description" : "The IBM Cloud location where a resource is deployed."
    }, {
      "name" : "resource_group",
      "type" : "string",
      "default" : "Default",
      "required" : true,
      "hidden" : false,
      "description" : "The IBM Cloud resource group where a resource is deployed."
    } ],
    "outputs" : [ {
      "name" : "vpc_cluster_id",
      "value" : "cluster_id"
    } ],
    "members" : [ {
      "name" : "foundation-deployable-architecture",
      "version_locator" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global",
      "inputs" : [ {
        "name" : "region",
        "value" : "us-south"
      }, {
        "name" : "cluster_name",
        "value" : "foundation-cluster"
      } ]
    }, {
      "name" : "middleware-architecture",
      "version_locator" : "01e1a9ad-534b-4ab9-996a-b8f2a8653d5c.4d86732e-04b9-4dab-bfdc-5b514d86ecd8",
      "inputs" : [ {
        "name" : "kube_version",
        "value" : 1.29
      } ]
    } ]
  },
  "created_at" : "2023-02-22T19:51:23.253Z",
  "modified_at" : "2023-02-22T19:51:23.253Z",
  "configuration" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "stack-bottom-up-example"
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/template",
  "references" : { }
}

`ibmcloud project stack-definition-update`

Mettez à jour la définition de pile associée à la configuration.

ibmcloud project stack-definition-update --id ID {--stack-definition STACK-DEFINITION | --stack-definition-inputs STACK-DEFINITION-INPUTS --stack-definition-outputs STACK-DEFINITION-OUTPUTS} [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

Options de commande

--id (chaîne)

ID de configuration unique. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--stack-definition (StackDefinitionBlockPrototype)

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --stack-definition=@path/to/file.json.

--stack-definition-inputs (StackDefinitionInputVariable[])

La longueur maximale est de 300 éléments. La longueur minimale est de 0.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --stack-definition-inputs=@path/to/file.json.

--stack-definition-outputs (StackDefinitionOutputVariable[])

Sorties associées à cette définition de pile. Cette option fournit une valeur pour une sous-zone de l'option JSON'stack-definition'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 100 éléments. La longueur minimale est de 0.

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemples

ibmcloud project stack-definition-update \
    --project-id exampleString \
    --id exampleString \
    --stack-definition '{"inputs": [{"name": "region", "type": "string", "description": "The IBM Cloud location where a resource is deployed.", "default": "eu-gb", "required": true, "hidden": false}], "outputs": [{"name": "exampleString", "value": "exampleString"}]}'

Des options granulaires sont également disponibles pour les sous-zones des options de chaîne JSON:

ibmcloud project stack-definition-update \
    --project-id exampleString \
    --id exampleString \
    --stack-definition-inputs '[stackDefinitionInputVariable]' \
    --stack-definition-outputs '[stackDefinitionOutputVariable]'

Exemple de sortie

Exemple de réponse d'une opération de modèle de pile de correctifs.

{
  "id" : "293c3c36-a094-4115-a12b-de0a9ca6678a",
  "stack_definition" : {
    "inputs" : [ {
      "name" : "region",
      "type" : "string",
      "required" : true,
      "default" : "eu-gb",
      "hidden" : false,
      "description" : "The IBM Cloud location where a resource is deployed."
    } ],
    "outputs" : [ {
      "name" : "vpc_cluster_id",
      "value" : "cluster_id"
    } ],
    "members" : [ {
      "name" : "foundation-deployable-architecture",
      "version_locator" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global",
      "inputs" : [ {
        "name" : "cluster_name",
        "value" : "foundation-cluster"
      } ]
    } ]
  },
  "state" : "draft",
  "created_at" : "2023-02-22T19:51:23.253Z",
  "modified_at" : "2023-02-22T19:51:23.253Z",
  "configuration" : {
    "id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
    "definition" : {
      "name" : "stack-bottom-up-example"
    },
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a"
  },
  "href" : "https://projects.api.cloud.ibm.com/v1/projects/cfbf9050-ab8e-ac97-b01b-ab5af830be8a/template"
}

`ibmcloud project stack-definition-export`

Exporte la pile d'architecture déployable dans un catalogue privé. Toutes les architectures déployables de membre dans la pile doivent être validées et déployées avant l'exportation de la pile. La définition de pile doit également exister avant l'exportation de la pile. La pile peut être exportée en tant que nouveau produit ou en tant que nouvelle version d'un produit existant.

ibmcloud project stack-definition-export --id ID [--settings SETTINGS | --settings-catalog-id SETTINGS-CATALOG-ID --settings-target-version SETTINGS-TARGET-VERSION --settings-variation SETTINGS-VARIATION --settings-label SETTINGS-LABEL --settings-tags SETTINGS-TAGS --settings-product-id SETTINGS-PRODUCT-ID] [--project-id PROJECT_ID] [--output FORMAT] [-q, --quiet]

Options de commande

--id (chaîne)

ID de configuration unique. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--settings (StackDefinitionExportRequest)

Contenu de la demande d'exportation de catalogue privé. Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin d'accès qui commence par @, par exemple --settings=@path/to/file.json.

--settings-catalog-id (chaîne)

ID catalogue à publier. Cette option fournit une valeur pour une sous-zone de l'option JSON'settings'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 36 caractères. La valeur doit correspondre à l'expression régulière /^[\\-0-9a-zA-Z]+$/.

--settings-target-version (chaîne)

La valeur du semver de cette nouvelle version du produit. Cette option fournit une valeur pour une sous-zone de l'option JSON'settings'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 60 caractères. La longueur minimale est de 5 caractères. La valeur doit correspondre à l'expression régulière /^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$/.

--settings-variation (chaîne)

La variation du logiciel actuel qui est embarqué. Valable uniquement si le type de produit est un module ou une solution. Voir flavor dans l'offre d'importation du catalogue. Cette option fournit une valeur pour une sous-zone de l'option JSON'settings'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.

--settings-label (chaîne)

Libellé du produit. Cette option fournit une valeur pour une sous-zone de l'option JSON'settings'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.

--settings-tags (chaîne[])

Balises associées au produit de catalogue. Cette option fournit une valeur pour une sous-zone de l'option JSON'settings'. Elle est mutuellement exclusive avec cette option.

La valeur par défaut est []. Les éléments de la liste doivent correspondre à l'expression régulière /^[a-zA-Z0-9][a-zA-Z0-9-_]*$/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--settings-product-id (chaîne)

ID produit à publier. Cette option fournit une valeur pour une sous-zone de l'option JSON'settings'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 36 caractères. La valeur doit correspondre à l'expression régulière /^[\\-0-9a-zA-Z]+$/.

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--output (chaîne)

Choisissez un format de sortie - peut être 'json', 'yaml', 'tui', ou 'table'. (par défaut 'table')

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemples

ibmcloud project stack-definition-export \
    --project-id exampleString \
    --id exampleString \
    --settings '{"catalog_id": "01e1a9ad-534b-4ab9-996a-b8f2a8653d5c", "target_version": "exampleString", "variation": "exampleString", "label": "Stack Deployable Architecture", "tags": []}'

Des options granulaires sont également disponibles pour les sous-zones des options de chaîne JSON:

ibmcloud project stack-definition-export \
    --project-id exampleString \
    --id exampleString \
    --settings-catalog-id exampleString \
    --settings-target-version exampleString \
    --settings-variation exampleString \
    --settings-label exampleString \
    --settings-tags '[]'

Exemple de sortie

Exemple de réponse de l'exportation d'une définition de pile dans le catalogue privé

{
  "catalog_id" : "01e1a9ad-534b-4ab9-996a-b8f2a8653d5c",
  "product_id" : "b60b5876-d074-478a-ac73-f979898c527b",
  "version_locator" : "01e1a9ad-534b-4ab9-996a-b8f2a8653d5c.f9f73bdb-5c7d-4ea6-82ef-9debc6340df8",
  "kind" : "terraform",
  "format" : "stack",
  "tags" : [ ]
}

`ibmcloud project config-versions`

Extrayez la liste des versions précédentes et en cours d'une configuration de projet dans un projet spécifique.

ibmcloud project config-versions --id ID [--project-id PROJECT-ID] [--output FORMAT] [-q, --quiet]

Options de commande

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--id (chaîne)

ID de configuration unique. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemple

ibmcloud project config-versions \
    --project-id exampleString \
    --id exampleString

Exemple de sortie

Exemple de réponse à une demande d'affichage de la liste des brouillons de configuration de projet.

{
  "versions" : [ {
    "definition" : {
      "locator_id" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global"
    },
    "version" : 1,
    "state" : "approved",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/db268db0-160b-4911-8f93-89659000a927/configs/293c3c36-a094-4115-a12b-de0a9ca39be5/versions/1"
  }, {
    "definition" : {
      "locator_id" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global"
    },
    "version" : 2,
    "state" : "validated",
    "href" : "https://projects.api.cloud.ibm.com/v1/projects/db268db0-160b-4911-8f93-89659000a927/configs/293c3c36-a094-4115-a12b-de0a9ca39be5/versions/2"
  } ]
}

Chemin d'accès JMES par défaut

Chemin d'accès JMES par défaut
Réponse	Sortie	Requête
Réussite	Valeur par défaut
	Tableau	`versions`
Erreur	Valeur par défaut
	Tableau	`versions`
Toutes les pages	Valeur par défaut
	Tableau	`versions`

Si une requête JMESPath personnalisée est fournie, elle remplacera toute requête JMESPath figurant dans le tableau ci-dessus.

`ibmcloud project config-version`

Extraire une version spécifique d'une configuration dans un projet.

ibmcloud project config-version [--project-id PROJECT-ID] --id ID --version VERSION

Options de commande

--project-id (chaîne)

ID de projet unique. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--id (chaîne)

ID de configuration unique. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--version (int64)

Version de la configuration. Obligatoire.

La valeur maximale est de 10000. La valeur minimale est 0.

-q, --quiet (bool)

Supprimer les messages prolixes.

Exemple

ibmcloud project config-version \
    --project-id exampleString \
    --id exampleString \
    --version 0

V2 Configurations

Commandes pour V2Configurations resource.

`ibmcloud project config-version-delete`

Supprimez une version de configuration en spécifiant l'ID de projet.

ibmcloud project config-version-delete [--project-id PROJECT-ID] --id ID --version VERSION

Options de commande

--project-id (chaîne)

ID de projet unique. Obligatoire si le projet n'est pas sélectionné.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--id (chaîne)

ID de configuration unique. Obligatoire.

La longueur maximale est de 128 caractères. La valeur doit correspondre à l'expression régulière /^[\\.\\-0-9a-zA-Z]+$/.

--version (int64)

Version de la configuration. Obligatoire.

La valeur maximale est de 10000. La valeur minimale est 0.

Exemple

ibmcloud project config-version-delete \
    --project-id exampleString \
    --id exampleString \
    --version 0

Exemple de sortie

Exemple de réponse à une demande de suppression d'une configuration.

{
  "id" : "293c3c36-a094-4115-a12b-de0a9ca39be5"
}

Exemples de schéma

Les exemples de schéma suivants représentent les données que vous devez spécifier pour une option de commande. Ces exemples modèlent la structure de données et incluent des valeurs de marque de réservation pour le type de valeur attendu. Lorsque vous exécutez une commande, remplacez comme il convient ces valeurs par les valeurs qui s'appliquent à votre environnement.

EnvironmentDefinitionPropertiesPatch

L'exemple suivant montre le format de l'objet EnvironmentDefinitionPropertiesPatch.


{
  "description" : "The environment development.",
  "name" : "development",
  "authorizations" : {
    "trusted_profile_id" : "Profile-9ac10c5c-195c-41ef-b465-68a6b6dg5f12",
    "method" : "trusted_profile",
    "api_key" : "exampleString"
  },
  "inputs" : {
    "anyKey" : "anyValue"
  },
  "compliance_profile" : {
    "id" : "some-profile-id",
    "instance_id" : "some-instance-id",
    "instance_location" : "us-south",
    "attachment_id" : "some-attachment-id",
    "profile_name" : "some-profile-name",
    "wp_policy_id" : "exampleString",
    "wp_instance_id" : "exampleString",
    "wp_instance_name" : "exampleString",
    "wp_instance_location" : "us-south",
    "wp_zone_id" : "exampleString",
    "wp_zone_name" : "exampleString",
    "wp_policy_name" : "exampleString"
  }
}

EnvironmentDefinitionRequiredProperties

L'exemple suivant montre le format de l'objet EnvironmentDefinitionRequiredProperties.


{
  "description" : "The environment development.",
  "name" : "development",
  "authorizations" : {
    "trusted_profile_id" : "Profile-9ac10c5c-195c-41ef-b465-68a6b6dg5f12",
    "method" : "trusted_profile",
    "api_key" : "exampleString"
  },
  "inputs" : {
    "anyKey" : "anyValue"
  },
  "compliance_profile" : {
    "id" : "some-profile-id",
    "instance_id" : "some-instance-id",
    "instance_location" : "us-south",
    "attachment_id" : "some-attachment-id",
    "profile_name" : "some-profile-name",
    "wp_policy_id" : "exampleString",
    "wp_instance_id" : "exampleString",
    "wp_instance_name" : "exampleString",
    "wp_instance_location" : "us-south",
    "wp_zone_id" : "exampleString",
    "wp_zone_name" : "exampleString",
    "wp_policy_name" : "exampleString"
  }
}

EnvironmentPrototype[]

L'exemple suivant montre le format de l'objet EnvironmentPrototype[] .


[ {
  "definition" : {
    "description" : "exampleString",
    "name" : "exampleString",
    "authorizations" : {
      "trusted_profile_id" : "exampleString",
      "method" : "exampleString",
      "api_key" : "exampleString"
    },
    "inputs" : {
      "anyKey" : "anyValue"
    },
    "compliance_profile" : { }
  }
} ]

ProjectComplianceProfile

L'exemple suivant montre le format de l'objet ProjectComplianceProfile.


{
  "id" : "exampleString",
  "instance_id" : "exampleString",
  "instance_location" : "us-south",
  "attachment_id" : "someattachmentid",
  "profile_name" : "SCCProfilev1.0",
  "wp_policy_id" : "exampleString",
  "wp_instance_id" : "exampleString",
  "wp_instance_name" : "exampleString",
  "wp_instance_location" : "us-south",
  "wp_zone_id" : "exampleString",
  "wp_zone_name" : "exampleString",
  "wp_policy_name" : "exampleString"
}

ProjectConfigAuth

L'exemple suivant montre le format de l'objet ProjectConfigAuth.


{
  "trusted_profile_id" : "Profile-9ac10c5c-195c-41ef-b465-68a6b6dg5f12",
  "method" : "trusted_profile",
  "api_key" : "exampleString"
}

ProjectConfigDefinitionPatch

L'exemple suivant montre le format de l'objet ProjectConfigDefinitionPatch.


{
  "compliance_profile" : { },
  "locator_id" : "exampleString",
  "members" : [ {
    "name" : "exampleString",
    "config_id" : "exampleString"
  } ],
  "description" : "exampleString",
  "name" : "env-stage",
  "authorizations" : {
    "trusted_profile_id" : "exampleString",
    "method" : "exampleString",
    "api_key" : "exampleString"
  },
  "inputs" : {
    "anyKey" : "anyValue"
  },
  "settings" : {
    "anyKey" : "anyValue"
  },
  "environment_id" : "exampleString"
}

ProjectConfigDefinitionPrototype

L'exemple suivant montre le format de l'objet ProjectConfigDefinitionPrototype.


{
  "compliance_profile" : { },
  "locator_id" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global",
  "members" : [ {
    "name" : "exampleString",
    "config_id" : "exampleString"
  } ],
  "description" : "The stage environment configuration.",
  "name" : "env-stage",
  "authorizations" : {
    "trusted_profile_id" : "exampleString",
    "method" : "exampleString",
    "api_key" : "exampleString"
  },
  "inputs" : {
    "anyKey" : "anyValue"
  },
  "settings" : {
    "anyKey" : "anyValue"
  },
  "environment_id" : "exampleString"
}

ProjectConfigPrototype[]

L'exemple suivant montre le format de l'objet ProjectConfigPrototype[] .


[ {
  "definition" : {
    "compliance_profile" : { },
    "locator_id" : "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.018edf04-e772-4ca2-9785-03e8e03bef72-global",
    "members" : [ {
      "name" : "exampleString",
      "config_id" : "exampleString"
    } ],
    "description" : "The stage account configuration.",
    "name" : "account-stage",
    "authorizations" : {
      "trusted_profile_id" : "exampleString",
      "method" : "exampleString",
      "api_key" : "exampleString"
    },
    "inputs" : {
      "anyKey" : "anyValue"
    },
    "settings" : {
      "anyKey" : "anyValue"
    },
    "environment_id" : "exampleString"
  },
  "schematics" : {
    "workspace_crn" : "crn:v1:staging:public:project:us-south:a/4e1c48fcf8ac33c0a2441e4139f189ae:bf40ad13-b107-446a-8286-c6d576183bb1::"
  }
} ]

ProjectDefinitionPatch

L'exemple suivant montre le format de l'objet ProjectDefinitionPatch.


{
  "name" : "acme-microservice",
  "description" : "A microservice to deploy on top of ACME infrastructure.",
  "auto_deploy_mode" : "auto_approval",
  "monitoring_enabled" : true,
  "destroy_on_delete" : true,
  "store" : {
    "type" : "gh",
    "url" : "exampleString",
    "token" : "exampleString",
    "config_directory" : "exampleString"
  },
  "terraform_engine" : {
    "id" : "exampleString",
    "type" : "terraform-enterprise"
  },
  "auto_deploy" : true
}

ProjectDefinitionStore

L'exemple suivant montre le format de l'objet ProjectDefinitionStore.


{
  "type" : "gh",
  "url" : "exampleString",
  "token" : "exampleString",
  "config_directory" : "exampleString"
}

ProjectPrototypeDefinition

L'exemple suivant montre le format de l'objet ProjectPrototypeDefinition.


{
  "name" : "acme-microservice",
  "description" : "A microservice to deploy on top of ACME infrastructure.",
  "auto_deploy_mode" : "manual_approval",
  "monitoring_enabled" : false,
  "destroy_on_delete" : true,
  "store" : {
    "type" : "gh",
    "url" : "exampleString",
    "token" : "exampleString",
    "config_directory" : "exampleString"
  },
  "terraform_engine" : {
    "id" : "exampleString",
    "type" : "terraform-enterprise"
  },
  "auto_deploy" : false
}

ProjectTerraformEngineSettings

L'exemple suivant montre le format de l'objet ProjectTerraformEngineSettings.


{
  "id" : "exampleString",
  "type" : "terraform-enterprise"
}

SchematicsWorkspace

L'exemple suivant montre le format de l'objet SchematicsWorkspace.


{
  "workspace_crn" : "crn:v1:staging:public:project:us-south:a/4e1c48fcf8ac33c0a2441e4139f189ae:bf40ad13-b107-446a-8286-c6d576183bb1::"
}

StackDefinitionBlockPrototype

L'exemple suivant montre le format de l'objet StackDefinitionBlockPrototype.


{
  "inputs" : [ {
    "name" : "region",
    "type" : "string",
    "description" : "The IBM Cloud location where a resource is deployed.",
    "default" : "us-south",
    "required" : true,
    "hidden" : false
  } ],
  "outputs" : [ {
    "name" : "vpc_cluster_id",
    "value" : "cluster_id"
  } ]
}

StackDefinitionExportRequest

L'exemple suivant montre le format de l'objet StackDefinitionExportRequest.


{
  "catalog_id" : "01e1a9ad-534b-4ab9-996a-b8f2a8653d5c",
  "target_version" : "exampleString",
  "variation" : "exampleString",
  "label" : "Stack Deployable Architecture",
  "tags" : [ ]
}

StackDefinitionInputVariable

L'exemple suivant montre le format de l'objet StackDefinitionInputVariable.


{
  "name" : "exampleString",
  "type" : "array",
  "description" : "exampleString",
  "default" : "exampleString",
  "required" : false,
  "hidden" : false
}

StackDefinitionOutputVariable

L'exemple suivant montre le format de l'objet StackDefinitionOutputVariable.


{
  "name" : "exampleString",
  "value" : "exampleString"
}

StackMember

L'exemple suivant montre le format de l'objet StackMember.


{
  "name" : "exampleString",
  "config_id" : "exampleString"
}

Autres commandes pertinentes pour les projets IBM Cloud

Les commandes suivantes ne font pas partie du plug-in d'interface de ligne de commande des projets, mais vous pouvez les utiliser pour effectuer des tâches liées aux projets, telles que l'association de balises à un projet. Cette liste n'est pas exhaustive de toutes les commandes pertinentes disponibles pour être utilisées avec les projets. Cette liste est plutôt un point de départ pour vous permettre d'explorer d'autres commandes que vous pouvez utiliser avec des projets.

Certaines des commandes suivantes peuvent nécessiter l'installation de leurs plug-in spécifiques avant de pouvoir les exécuter.

Exécutez ibmcloud resource tag-attach pour associer des balises à un projet:

ibmcloud resource tag-attach --tag-names TAG --resource-id PROJECT-CRN

Exécuter ibmcloud resource search pour récupérer toutes les ressources d'un compte créé par des configurations dans un projet :

ibmcloud resource search "service_tags:\"schematics::project_id:PROJECT_ID\""

Exécutez ibmcloud schematics logs pour extraire les fichiers journaux d'un espace de travail Schematics:

ibmcloud schematics logs --id WORKSPACE_ID [--act-id ACTION_ID]