Projekt-CLI-Referenz

Die Befehlszeilenschnittstelle IBM Cloud® ( IBM Cloud CLI) bietet zusätzliche Funktionen für Serviceangebote. Sie können die IBM Cloud CLI verwenden, um Projekte zu verwalten, auf die Sie Zugriff haben.

Vorbereitende Schritte

Installieren Sie die IBM Cloud-CLI.
Installieren Sie das Project CLI, indem Sie den folgenden Befehl ausführen:

ibmcloud plugin install project

Sie werden über die Befehlszeile benachrichtigt, wenn Aktualisierungen für die IBM Cloud-CLI und -Plug-ins verfügbar sind. Stellen Sie sicher, dass die Befehlszeilenschnittstelle auf dem neuesten Stand ist, damit Sie die aktuellen Befehle nutzen können. Sie können die aktuelle Version aller installierten Plug-ins anzeigen, indem Sie den Befehl ibmcloud plugin list ausführen.

Projekte

Befehle für die Ressource 'Projekte'.

`ibmcloud project select`

Alias: target

Ein Projekt als aktuellen Kontext auswählen.

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

Beispiele

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

Alternativ können Sie auch nach Projektnamen auswählen

ibmcloud project select ProjectA

So heben Sie die Auswahl eines Projekts auf

ibmcloud project select --unset-project

Befehlsoptionen

--unset-project (boolescher Wert): Nicht festgelegtes Zielprojekt
--output (Zeichenfolge): Wählen Sie ein Ausgabeformat - kann 'json' oder 'table' sein. (Standard 'Tabelle')
-q, --quiet (boolescher Wert): Unterdrückt Nachrichten mit ausführlichen Informationen.

ibmcloud project select --unset-project

`ibmcloud project create`

Erstellen Sie ein Projekt und richten Sie die Werkzeuge für dessen Verwaltung asynchron ein. Fügen Sie eine implementierbare Architektur hinzu, indem Sie die Konfiguration anpassen. Nachdem die Änderungen validiert und genehmigt wurden, implementieren Sie die Ressourcen, die das Projekt konfiguriert. Weitere Informationen finden Sie unter Projekt erstellen.

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]

Befehlsoptionen

--definition (ProjectPrototypeDefinition)

Die Definition des Projekts Diese JSON-Option kann stattdessen bereitgestellt werden, indem einzelne Felder mit anderen Optionen festgelegt werden. Sie und diese Optionen schließen sich gegenseitig aus.

Geben Sie eine JSON-String-Option an oder geben Sie eine JSON-Datei an, aus der gelesen werden soll, indem Sie eine Dateipfad-Option angeben, die mit einem @ beginnt, z. B. --definition=@path/to/file.json.

--location (Zeichenfolge)

Die IBM Cloud-Position, an der eine Ressource bereitgestellt wird Erforderlich.

Zulässige Werte sind: us-south, us-east, eu-gb, eu-de, ca-tor.

--resource-group (Zeichenfolge)

Der Name der Ressourcengruppe, in der die Daten und Tools des Projekts erstellt werden. Erforderlich.

Die maximale Länge beträgt 64 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/ entsprechen.

--configs (ProjectConfigPrototype[])

Die Projektkonfigurationen. Diese Konfigurationen werden in die Antwort zum Erstellen eines Projekts nur eingeschlossen, wenn ein Konfigurationsarray in den Anforderungsnutzdaten angegeben ist.

Der Standardwert ist []. Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--environments (EnvironmentPrototype[])

Die Projektumgebung. Diese Umgebungen werden in die Antwort zum Erstellen eines Projekts nur eingeschlossen, wenn ein Umgebungsarray in den Anforderungsnutzdaten angegeben ist.

Der Standardwert ist []. Die maximale Länge beträgt 20. Die Mindestlänge beträgt 0.

--definition-name (Zeichenfolge)

Der Name des Projekts. Es ist innerhalb des Kontos regionsübergreifend eindeutig. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Der Wert muss dem regulären Ausdruck /^(?!\\s)(?!.*\\s$)[^'"`\/<>{}\\x00-\\x1F]+$/ entsprechen.

--definition-description (Zeichenfolge)

Eine kurze Erläuterung der Verwendung des Projekts in der Konfiguration einer implementierbaren Architektur Ein Projekt kann auch ohne eine Beschreibung erstellt werden. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Der Standardwert ist . Die maximale Länge beträgt 1024 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/ entsprechen.

--definition-auto-deploy-mode (Zeichenfolge)

Dies ist eine erweiterte Einstellung für die automatische Bereitstellung, die angibt, wie sich die automatische Bereitstellung verhalten soll, wenn sie aktiviert ist. Es gibt 2 Optionen:

auto_approval wird die Konfiguration automatisch genehmigt, nachdem sie ohne Benutzerbestätigung validiert wurde.

manual_approval erfordert eine Bestätigung des Benutzers, um die Konfiguration nach der Validierung zu genehmigen, bevor die Bereitstellung der Konfiguration beginnt. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Der Standardwert ist manual_approval. Erlaubte Werte sind: auto_approval, manual_approval.

--definition-monitoring-enabled (boolescher Wert)

Ein boolesches Flag zum Aktivieren der automatischen Drifterkennung. Verwenden Sie dieses Feld, um eine tägliche Prüfung durchzuführen, um die Konfigurationen mit den bereitgestellten Ressourcen zu vergleichen und eventuelle Unterschiede festzustellen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Der Standardwert ist false.

--definition-destroy-on-delete (boolescher Wert)

Die Richtlinie, die angibt, ob die Ressourcen deimplementiert werden, wenn ein Projekt gelöscht wird. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Der Standardwert ist true.

--definition-store (ProjectDefinitionStore)

Die für die benutzerdefinierte Speicherung von Projektkonfigurationen erforderlichen Details. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

--definition-terraform-engine (ProjectTerraformEngineSettings)

Experimentelles Schema - dies ist für Prototyping-Zwecke gedacht. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

--definition-auto-deploy (boolescher Wert)

Ein boolesches Flag, um die automatische Bereitstellung von Konfigurationen zu aktivieren. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Der Standardwert ist false.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiele

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": {}}}]'

Alternativ sind differenzierte Optionen für die Unterfelder von JSON-Zeichenfolgeoptionen verfügbar:

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`

Vorhandene Projekte auflisten. Projekte sind nach ID sortiert. Hinweis: Wenn die Option --all-pages nicht gesetzt ist, ruft der Befehl nur eine einzige Seite der Sammlung ab.

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

Befehlsoptionen

--token (Zeichenfolge)

Der Server verwendet diesen Parameter, um den ersten Eintrag festzulegen, der auf der nächsten Seite zurückgegeben wird. Wird dieser Parameter nicht angegeben, wird die logische erste Seite zurückgegeben.

Der Standardwert ist . Die maximale Länge beträgt 1536 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/ entsprechen.

--limit (int64)

Die maximale Anzahl der zurückzugebenden Ressourcen. Die Anzahl der zurückgegebenen Ressourcen ist mit Ausnahme der letzten Seite identisch.

Der Standardwert ist 10. Der Höchstwert ist 100. Der Mindestwert ist 1.

--all-pages (boolescher Wert)

Rufen Sie mehrere Anfragen auf, um alle Seiten der Sammlung für Liste anzuzeigen.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiel

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

Beispielausgabe

Eine Beispielanforderung zum Auflisten von Projekten.

{
  "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" : [ ]
  } ]
}

Standard-JMESPfad

Auf die Ausgabe dieses Befehls wird standardmäßig eine JMESPath-Abfrage angewandt, wenn sie nicht vom Benutzer angegeben wird. Die genaue Abfrage hängt vom jeweiligen Szenario und dem gewünschten Ausgabeformat ab. Die Bedingungen für jede Standard-JMESPath-Abfrage können Sie der folgenden Tabelle entnehmen:

Standard-JMESPfad
Antwort	Ausgabe	Abfrage
Erfolg	Standard
	Tabelle	`projects[].{id: id, name: definition.name, state: state}`
Fehler	Standard
	Tabelle	`projects[].{id: id, name: definition.name, state: state}`
Alle Seiten	Standard
	Tabelle	`projects[].{id: id, name: definition.name, state: state}`

Wenn eine benutzerdefinierte JMESPath-Abfrage angegeben wird, ersetzt sie alle JMESPaths in der obigen Tabelle.

`ibmcloud project get`

Informationen über ein Projekt abrufen.

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

Befehlsoptionen

--id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

Beispiel

ibmcloud project get \
    --id exampleString

Beispielausgabe

Eine Beispielantwort zum Abrufen eines Projekts mit Konfigurationen.

{
  "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"
}

Standard-JMESPfad

Standard-JMESPfad
Antwort	Ausgabe	Abfrage
Erfolg	Standard
	Tabelle	`{id: id, name: definition.name, state: state}`
Fehler	Standard
	Tabelle	`{id: id, name: definition.name, state: state}`
Alle Seiten	Standard
	Tabelle	`{id: id, name: definition.name, state: state}`

Wenn eine benutzerdefinierte JMESPath-Abfrage angegeben wird, ersetzt sie alle JMESPaths in der obigen Tabelle.

`ibmcloud project update`

Aktualisieren Sie ein Projekt, indem Sie seine ID angeben.

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]

Befehlsoptionen

--id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--definition (ProjectDefinitionPatch)

--definition-name (Zeichenfolge)

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Der Wert muss dem regulären Ausdruck /^(?!\\s)(?!.*\\s$)[^'"`\/<>{}\\x00-\\x1F]+$/ entsprechen.

--definition-description (Zeichenfolge)

Die maximale Länge beträgt 1024 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/ entsprechen.

--definition-auto-deploy-mode (Zeichenfolge)

Dies ist eine erweiterte Einstellung für die automatische Bereitstellung, die angibt, wie sich die automatische Bereitstellung verhalten soll, wenn sie aktiviert ist. Es gibt 2 Optionen:

auto_approval wird die Konfiguration automatisch genehmigt, nachdem sie ohne Benutzerbestätigung validiert wurde.

manual_approval erfordert eine Bestätigung des Benutzers, um die Konfiguration nach der Validierung zu genehmigen, bevor die Bereitstellung der Konfiguration beginnt. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Zulässige Werte: auto_approval, manual_approval.

--definition-monitoring-enabled (boolescher Wert)

--definition-destroy-on-delete (boolescher Wert)

--definition-store (ProjectDefinitionStore)

--definition-terraform-engine (ProjectTerraformEngineSettings)

--definition-auto-deploy (boolescher Wert)

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiele

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}'

Alternativ sind differenzierte Optionen für die Unterfelder von JSON-Zeichenfolgeoptionen verfügbar:

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

Beispielausgabe

Eine Beispielantwort zum Abrufen eines Projekts mit Konfigurationen.

{
  "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`

Löschen Sie ein Projektdokument, indem Sie die ID angeben. Ein Projekt kann erst dann gelöscht werden, wenn alle seine Ressourcen gelöscht wurden.

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

Befehlsoptionen

--id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

Beispiel

ibmcloud project delete \
    --id exampleString

Beispielausgabe

Die Beispielantwort auf eine Anforderung zum Löschen eines Projekts

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

Umgebungen

Befehle für Umgebungsressource.

`ibmcloud project environment-create`

Erstellen Sie eine Umgebung, um zusammengehörige Konfigurationen zu gruppieren und Werte gemeinsam zu nutzen, um die Implementierung zu vereinfachen. Weitere Informationen finden Sie unter Umgebung erstellen.

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]

Befehlsoptionen

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--definition (EnvironmentDefinitionRequiredProperties)

Die Umgebungsdefinition. Diese JSON-Option kann stattdessen bereitgestellt werden, indem einzelne Felder mit anderen Optionen festgelegt werden. Sie und diese Optionen schließen sich gegenseitig aus.

--definition-description (Zeichenfolge)

Die Beschreibung der Umgebung. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

--definition-name (Zeichenfolge)

Der Name der Umgebung. Es ist innerhalb des Kontos über Projekte und Regionen hinweg einzigartig. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Der Wert muss dem regulären Ausdruck /^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]+$/ entsprechen.

--definition-authorizations (ProjectConfigAuth)

Die Autorisierungsdetails Sie können die Berechtigung mithilfe eines vertrauenswürdigen Profils oder eines API-Schlüssels in Secrets Managererteilen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

--definition-inputs (generische Map)

Die Eingabevariablen, die für die Konfigurationsdefinition und Umgebung verwendet werden. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

--definition-compliance-profile (ProjectComplianceProfile)

Das Profil, das für die Konformität erforderlich ist. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiele

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"}}'

Alternativ sind differenzierte Optionen für die Unterfelder von JSON-Zeichenfolgeoptionen verfügbar:

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

Beispielausgabe

Die Antwort der Beispielumgebung.

{
  "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`

Alle verfügbaren Umgebungen auflisten. Weitere Informationen finden Sie unter Umgebung erstellen. Hinweis: Wenn die Option --all-pages nicht gesetzt ist, ruft der Befehl nur eine einzige Seite der Sammlung ab.

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

Befehlsoptionen

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--token (Zeichenfolge)

--limit (int64)

Die maximale Anzahl der zurückzugebenden Ressourcen. Die Anzahl der zurückgegebenen Ressourcen ist mit Ausnahme der letzten Seite identisch.

Der Standardwert ist 10. Der Höchstwert ist 100. Der Mindestwert ist 1.

--all-pages (boolescher Wert)

Rufen Sie mehrere Anfragen auf, um alle Seiten der Sammlung für Umgebungen anzuzeigen.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiel

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

Beispielausgabe

Die Beispielumgebungsantwort für eine 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`

Umgebung abrufen. Weitere Informationen.

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

Befehlsoptionen

--id (Zeichenfolge)

Die Umgebungs-ID. Erforderlich.

Die maximale Länge beträgt 256 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Der Wert muss dem regulären Ausdruck /^(?!\\s)(?!.*\\s$).+$/ entsprechen.

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiel

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

Beispielausgabe

Die Antwort der Beispielumgebung.

{
  "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`

Eine Umgebung durch Angabe ihrer ID aktualisieren. Weitere Informationen.

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]

Befehlsoptionen

--id (Zeichenfolge)

Die Umgebungs-ID. Erforderlich.

Die maximale Länge beträgt 256 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Der Wert muss dem regulären Ausdruck /^(?!\\s)(?!.*\\s$).+$/ entsprechen.

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--definition (EnvironmentDefinitionPropertiesPatch)

Die für Aktualisierungen verwendete Umgebungsdefinition. Diese JSON-Option kann stattdessen bereitgestellt werden, indem einzelne Felder mit anderen Optionen festgelegt werden. Sie und diese Optionen schließen sich gegenseitig aus.

--definition-description (Zeichenfolge)

Die Beschreibung der Umgebung. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 1024 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/ entsprechen.

--definition-name (Zeichenfolge)

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Der Wert muss dem regulären Ausdruck /^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]+$/ entsprechen.

--definition-authorizations (ProjectConfigAuth)

--definition-inputs (generische Map)

--definition-compliance-profile (ProjectComplianceProfile)

Das Profil, das für die Konformität erforderlich ist. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiele

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"}}'

Alternativ sind differenzierte Optionen für die Unterfelder von JSON-Zeichenfolgeoptionen verfügbar:

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

Beispielausgabe

Die Antwort der Beispielumgebung.

{
  "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`

Eine Umgebung in einem Projekt durch Angabe ihrer ID löschen.

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

Befehlsoptionen

--id (Zeichenfolge)

Die Umgebungs-ID. Erforderlich.

Die maximale Länge beträgt 256 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Der Wert muss dem regulären Ausdruck /^(?!\\s)(?!.*\\s$).+$/ entsprechen.

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiel

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

Beispielausgabe

Die Beispielantwort zum Löschen der Umgebung.

{
  "id" : "env123"
}

Konfigurationen

Befehle für die Ressource 'Konfigurationen'.

`ibmcloud project config-create`

Fügen Sie eine neue Konfiguration zu einem Projekt hinzu.

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]

Befehlsoptionen

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--definition (ProjectConfigDefinitionPrototype)

Diese JSON-Option kann stattdessen bereitgestellt werden, indem einzelne Felder mit anderen Optionen festgelegt werden. Sie und diese Optionen schließen sich gegenseitig aus.

--schematics (SchematicsWorkspace)

Ein Schematics-Arbeitsbereich für die Implementierung dieser implementierbaren Architektur.

Wenn Sie Daten aus einem bestehenden Schematics Arbeitsbereich importieren, der nicht durch Cart gesichert ist, müssen Sie eine locator_id angeben. Wenn Sie einen Schematics-Arbeitsbereich verwenden, der von Cart unterstützt wird, ist ein locator_id nicht erforderlich, da der Schematics-Arbeitsbereich über einen solchen verfügt.

Es gibt drei Szenarios:

Wenn nur ein locator_id angegeben wird, wird ein neuer Schematics-Arbeitsbereich mit diesem locator_id instanziiert.

Wenn nur ein Schema workspace_crn angegeben wird, wird ein 400 zurückgegeben, wenn kein locator_id im vorhandenen Schematics-Arbeitsbereich gefunden wird.

Wenn sowohl ein Schematics workspace_crn als auch ein locator_id angegeben sind, wird ein 400 Code zurückgegeben, wenn der angegebene locator_id nicht mit dem locator_id im vorhandenen Schematics Arbeitsbereich übereinstimmt.

Weitere Informationen finden Sie unter Erstellen von Arbeitsbereichen und Importieren der Terraform-Vorlage. Diese JSON-Option kann stattdessen bereitgestellt werden, indem einzelne Felder mit anderen Optionen festgelegt werden. Sie und diese Optionen schließen sich gegenseitig aus.

--definition-compliance-profile (ProjectComplianceProfile)

Das Profil, das für die Konformität erforderlich ist. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

--definition-locator-id (Zeichenfolge)

Eine eindeutige Verknüpfung der Katalog-ID und der Versions-ID, die die implementierbare Architektur im Katalog identifiziert. Wenn Sie aus einem bestehenden Schematics Arbeitsbereich importieren, der nicht durch Cart gesichert ist, ist locator_id erforderlich. Wenn Sie einen Schematics-Arbeitsbereich verwenden, der von Cart unterstützt wird, ist ein locator_id nicht erforderlich, da der Schematics-Arbeitsbereich über einen solchen verfügt.

Es gibt drei Szenarios:

Wenn nur ein locator_id angegeben wird, wird ein neuer Schematics-Arbeitsbereich mit diesem locator_id instanziiert.

Wenn nur ein Schema workspace_crn angegeben wird, wird ein 400 zurückgegeben, wenn kein locator_id im vorhandenen Schematics-Arbeitsbereich gefunden wird.

Wenn sowohl Schematics workspace_crn als auch locator_id angegeben sind, wird eine 400-Nachricht zurückgegeben, wenn die angegebene locator_id nicht mit der locator_id im vorhandenen Schematics-Arbeitsbereich übereinstimmt. Weitere Informationen zur Erstellung eines Schematics Arbeitsbereichs finden Sie unter Erstellen von Arbeitsbereichen und Importieren der Terraform-Vorlage. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 512 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Der Wert muss dem regulären Ausdruck /^(?!\\s)(?!.*\\s$)[\\.0-9a-z-A-Z_-]+$/ entsprechen.

--definition-members (StackMember[])

Die einsatzfähigen Architekturen der Mitglieder, die im Stack enthalten sind. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--definition-uses (ProjectConfigUses[])

Die abhängigen Deployment-Architekturen, die von dieser Konfiguration referenziert werden. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--definition-description (Zeichenfolge)

Eine Projektkonfigurationsbeschreibung. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

--definition-name (Zeichenfolge)

Der Name der Konfiguration. Es ist innerhalb des Kontos über Projekte und Regionen hinweg einzigartig. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Der Wert muss dem regulären Ausdruck /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/ entsprechen.

--definition-authorizations (ProjectConfigAuth)

Die Autorisierungsdetails Die Autorisierung kann über ein vertrauenswürdiges Profil oder einen API-Schlüssel in Secrets Manager erfolgen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

--definition-inputs (generische Map)

--definition-settings (generische Map)

Die Schematics-Umgebungsvariablen für die Implementierung der Konfiguration. Einstellungen sind nur verfügbar, wenn sie bei der Ersterstellung der Konfiguration angegeben werden. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

--definition-environment-id (Zeichenfolge)

Die ID der Projektumgebung. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--definition-resource-crns ([]zeichenfolge)

Die CRNs der Ressourcen, die dieser Konfiguration zugeordnet sind Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/ entsprechen. Die maximale Länge beträgt 110. Die Mindestlänge beträgt 0.

--schematics-workspace-crn (Zeichenfolge)

Ein IBM Cloud-Ressourcenname, der eine Ressource eindeutig identifiziert. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'schematics' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 512 Zeichen. Die Mindestlänge beträgt 4 Zeichen. Der Wert muss dem regulären Ausdruck /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/ entsprechen.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiele

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::"}'

Alternativ sind differenzierte Optionen für die Unterfelder von JSON-Zeichenfolgeoptionen verfügbar:

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`

Rufen Sie die Sammlung der Konfigurationen ab. Hinweis: Wenn die Option --all-pages nicht gesetzt ist, ruft der Befehl nur eine einzige Seite der Sammlung ab.

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

Befehlsoptionen

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--token (Zeichenfolge)

--limit (int64)

Die maximale Anzahl der zurückzugebenden Ressourcen. Die Anzahl der zurückgegebenen Ressourcen ist mit Ausnahme der letzten Seite identisch.

Der Standardwert ist 10. Der Höchstwert ist 100. Der Mindestwert ist 1.

--all-pages (boolescher Wert)

Rufen Sie mehrere Anfragen auf, um alle Seiten der Sammlung für Konfigs anzuzeigen.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiel

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

Beispielausgabe

Die Beispielantwort für eine Anfrage zum Abrufen von Projektkonfigurationen

{
  "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"
  } ]
}

Standard-JMESPfad

Standard-JMESPfad
Antwort	Ausgabe	Abfrage
Erfolg	Standard
	Tabelle	`configs[].{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`
Fehler	Standard
	Tabelle	`configs[].{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`
Alle Seiten	Standard
	Tabelle	`configs[].{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`

Wenn eine benutzerdefinierte JMESPath-Abfrage angegeben wird, ersetzt sie alle JMESPaths in der obigen Tabelle.

`ibmcloud project config`

Ruft die angegebene Projektkonfiguration in einem bestimmten Projekt ab.

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

Befehlsoptionen

--id (Zeichenfolge)

Die eindeutige Konfigurations-ID. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

Beispiel

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

Standard-JMESPfad

Standard-JMESPfad
Antwort	Ausgabe	Abfrage
Erfolg	Standard
	Tabelle	`{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`
Fehler	Standard
	Tabelle	`{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`
Alle Seiten	Standard
	Tabelle	`{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`

Wenn eine benutzerdefinierte JMESPath-Abfrage angegeben wird, ersetzt sie alle JMESPaths in der obigen Tabelle.

`ibmcloud project config-update`

Aktualisieren Sie eine Konfiguration in einem Projekt, indem Sie die ID angeben. Weitere Informationen.

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]

Befehlsoptionen

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Konfigurations-ID. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--definition (ProjectConfigDefinitionPatch)

Diese JSON-Option kann stattdessen bereitgestellt werden, indem einzelne Felder mit anderen Optionen festgelegt werden. Sie und diese Optionen schließen sich gegenseitig aus.

--definition-compliance-profile (ProjectComplianceProfile)

Das Profil, das für die Konformität erforderlich ist. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

--definition-locator-id (Zeichenfolge)

Es gibt drei Szenarios:

Wenn nur ein locator_id angegeben wird, wird ein neuer Schematics-Arbeitsbereich mit diesem locator_id instanziiert.

Wenn nur ein Schema workspace_crn angegeben wird, wird ein 400 zurückgegeben, wenn kein locator_id im vorhandenen Schematics-Arbeitsbereich gefunden wird.

Wenn sowohl Schematics workspace_crn als auch locator_id angegeben sind, wird eine 400-Nachricht zurückgegeben, wenn die angegebene locator_id nicht mit der locator_id im vorhandenen Schematics-Arbeitsbereich übereinstimmt. Weitere Informationen zur Erstellung eines Schematics Arbeitsbereichs finden Sie unter Erstellen von Arbeitsbereichen und Importieren der Terraform-Vorlage. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 512 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Der Wert muss dem regulären Ausdruck /^(?!\\s)(?!.*\\s$)[\\.0-9a-z-A-Z_-]+$/ entsprechen.

--definition-members (StackMember[])

Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--definition-uses (ProjectConfigUses[])

Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--definition-description (Zeichenfolge)

Eine Projektkonfigurationsbeschreibung. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 1024 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/ entsprechen.

--definition-name (Zeichenfolge)

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Der Wert muss dem regulären Ausdruck /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/ entsprechen.

--definition-authorizations (ProjectConfigAuth)

--definition-inputs (generische Map)

--definition-settings (generische Map)

--definition-environment-id (Zeichenfolge)

Die ID der Projektumgebung. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--definition-resource-crns ([]zeichenfolge)

Die Listenelemente müssen dem regulären Ausdruck /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/ entsprechen. Die maximale Länge beträgt 110. Die Mindestlänge beträgt 0.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiele

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"}'

Alternativ sind differenzierte Optionen für die Unterfelder von JSON-Zeichenfolgeoptionen verfügbar:

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`

Eine Konfiguration in einem Projekt durch Angabe ihrer ID löschen.

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

Befehlsoptionen

--id (Zeichenfolge)

Die eindeutige Konfigurations-ID. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

Beispiel

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

Beispielausgabe

Die Beispielantwort auf eine Anfrage zum Löschen einer Konfiguration.

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

`ibmcloud project config-force-approve`

Erzwingen Sie die Genehmigung von Konfigurationsänderungen an der Hauptkonfiguration mit einem Genehmigungskommentar.

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

Befehlsoptionen

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Konfigurations-ID. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--comment (Zeichenfolge)

Anmerkungen zur Projektentwurfsaktion. Wenn es sich bei dieser Aktion um eine Zwangsgenehmigung des Konfigurationsentwurfs handelt, muss sie einen nicht leeren Kommentar enthalten. Erforderlich.

Die maximale Länge beträgt 1024 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Der Wert muss dem regulären Ausdruck /^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]+$/ entsprechen.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiel

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

Beispielausgabe

Die Beispielantwort auf eine Anforderung für einen Entwurf einer implementierbaren Architekturkonfiguration.

{
  "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`

Genehmigen und mischen Sie Konfigurationsbearbeitungen an der Hauptkonfiguration.

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

Befehlsoptionen

--id (Zeichenfolge)

Die eindeutige Konfigurations-ID. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--comment (Zeichenfolge)

Anmerkungen zur Projektentwurfsaktion. Wenn es sich bei dieser Aktion um eine Zwangsgenehmigung des Konfigurationsentwurfs handelt, muss sie einen nicht leeren Kommentar enthalten.

Die maximale Länge beträgt 1024 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Der Wert muss dem regulären Ausdruck /^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]+$/ entsprechen.

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiel

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

Beispielausgabe

Die Beispielantwort auf eine Anforderung für einen Entwurf einer implementierbaren Architekturkonfiguration.

{
  "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`

Führen Sie eine Gültigkeitsprüfung für eine bestimmte Konfiguration im Projekt aus. Die Prüfung umfasst die Erstellung oder Aktualisierung des zugeordneten Arbeitsbereichs Schematics mit einem Planjob, die Ausführung der CRA-Scans und die Kostenschätzung.

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

Befehlsoptionen

--id (Zeichenfolge)

Die eindeutige Konfigurations-ID. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiel

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

Beispielausgabe

Die Beispielantwort auf eine Anforderung für einen Entwurf einer implementierbaren Architekturkonfiguration.

{
  "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`

Führt eine Validierungsprüfung einer über die API übergebenen Konfiguration durch. Die Prüfung umfasst die Erstellung eines Schematics Arbeitsbereichs mit einem Planauftrag, die Durchführung der CRA-Scans und die Kostenschätzung.

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]

Befehlsoptionen

--id (Zeichenfolge)

Die eindeutige Konfigurations-ID. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--definition (ProjectConfigDefinitionPrototype)

Diese JSON-Option kann stattdessen bereitgestellt werden, indem einzelne Felder mit anderen Optionen festgelegt werden. Sie und diese Optionen schließen sich gegenseitig aus.

--schematics (SchematicsWorkspace)

Ein Schematics-Arbeitsbereich für die Implementierung dieser implementierbaren Architektur.

Wenn Sie Daten aus einem bestehenden Schematics Arbeitsbereich importieren, der nicht durch Cart gesichert ist, müssen Sie eine locator_id angeben. Wenn Sie einen Schematics-Arbeitsbereich verwenden, der von Cart unterstützt wird, ist ein locator_id nicht erforderlich, da der Schematics-Arbeitsbereich über einen solchen verfügt.

Es gibt drei Szenarios:

Wenn nur ein locator_id angegeben wird, wird ein neuer Schematics-Arbeitsbereich mit diesem locator_id instanziiert.

Wenn nur ein Schema workspace_crn angegeben wird, wird ein 400 zurückgegeben, wenn kein locator_id im vorhandenen Schematics-Arbeitsbereich gefunden wird.

Wenn sowohl ein Schematics workspace_crn als auch ein locator_id angegeben sind, wird ein 400 Code zurückgegeben, wenn der angegebene locator_id nicht mit dem locator_id im vorhandenen Schematics Arbeitsbereich übereinstimmt.

--definition-compliance-profile (ProjectComplianceProfile)

Das Profil, das für die Konformität erforderlich ist. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

--definition-locator-id (Zeichenfolge)

Es gibt drei Szenarios:

Wenn nur ein locator_id angegeben wird, wird ein neuer Schematics-Arbeitsbereich mit diesem locator_id instanziiert.

Wenn nur ein Schema workspace_crn angegeben wird, wird ein 400 zurückgegeben, wenn kein locator_id im vorhandenen Schematics-Arbeitsbereich gefunden wird.

Wenn sowohl Schematics workspace_crn als auch locator_id angegeben sind, wird eine 400-Nachricht zurückgegeben, wenn die angegebene locator_id nicht mit der locator_id im vorhandenen Schematics-Arbeitsbereich übereinstimmt. Weitere Informationen zur Erstellung eines Schematics Arbeitsbereichs finden Sie unter Erstellen von Arbeitsbereichen und Importieren der Terraform-Vorlage. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 512 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Der Wert muss dem regulären Ausdruck /^(?!\\s)(?!.*\\s$)[\\.0-9a-z-A-Z_-]+$/ entsprechen.

--definition-members (StackMember[])

Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--definition-uses (ProjectConfigUses[])

Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--definition-description (Zeichenfolge)

Eine Projektkonfigurationsbeschreibung. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

--definition-name (Zeichenfolge)

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Der Wert muss dem regulären Ausdruck /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/ entsprechen.

--definition-authorizations (ProjectConfigAuth)

--definition-inputs (generische Map)

--definition-settings (generische Map)

--definition-environment-id (Zeichenfolge)

Die ID der Projektumgebung. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--definition-resource-crns ([]zeichenfolge)

Die Listenelemente müssen dem regulären Ausdruck /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/ entsprechen. Die maximale Länge beträgt 110. Die Mindestlänge beträgt 0.

--schematics-workspace-crn (Zeichenfolge)

Die maximale Länge beträgt 512 Zeichen. Die Mindestlänge beträgt 4 Zeichen. Der Wert muss dem regulären Ausdruck /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/ entsprechen.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiele

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::"}'

Alternativ sind differenzierte Optionen für die Unterfelder von JSON-Zeichenfolgeoptionen verfügbar:

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::

Beispielausgabe

Das Ergebnisobjekt für prevalidate.

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

`ibmcloud project get-prevalidate`

Abrufen der Prävalidierungsergebnisse unter Verwendung eines Schlüssels.

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

Befehlsoptionen

--id (Zeichenfolge)

Die eindeutige Konfigurations-ID. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--result-id (Zeichenfolge)

Der eindeutige Bezeichner zum Abrufen von Prävalidierungsereignissen. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiel

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

Beispielausgabe

Ein Antwortbeispiel für die Abfrage von Prävalidierungsergebnissen.

{
  "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`

Implementieren Sie die Konfiguration eines Projekts. Dieser Vorgang ist asynchron und kann mit Hilfe der Projektkonfigurations-API mit vollständigen Metadaten nachverfolgt werden.

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

Befehlsoptionen

--id (Zeichenfolge)

Die eindeutige Konfigurations-ID. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiel

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

Beispielausgabe

Die Beispielantwort auf eine Anforderung für einen Entwurf einer implementierbaren Architekturkonfiguration.

{
  "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`

Deimplementieren Sie die Konfigurationsressourcen eines Projekts. Die Operation deimplementiert alle Ressourcen, die mit der spezifischen Konfiguration implementiert werden. Die Konfigurationsressourcen können mit Hilfe der Projektkonfigurations-API mit vollständigen Metadaten nachverfolgt werden.

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

Befehlsoptionen

--id (Zeichenfolge)

Die eindeutige Konfigurations-ID. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiel

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

Beispielausgabe

Die Beispielantwort auf eine Anforderung für einen Entwurf einer implementierbaren Architekturkonfiguration.

{
  "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`

Synchronisieren Sie eine Projektkonfiguration, indem Sie die zugehörigen Pipelineausführungen und Schematics-Arbeitsbereichsprotokolle analysieren, um die Konfiguration wieder in einen Betriebsstatus zu versetzen.

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

Befehlsoptionen

--id (Zeichenfolge)

Die eindeutige Konfigurations-ID. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--schematics (SchematicsWorkspace)

Ein Schematics-Arbeitsbereich für die Implementierung dieser implementierbaren Architektur.

Wenn Sie Daten aus einem bestehenden Schematics Arbeitsbereich importieren, der nicht durch Cart gesichert ist, müssen Sie eine locator_id angeben. Wenn Sie einen Schematics-Arbeitsbereich verwenden, der von Cart unterstützt wird, ist ein locator_id nicht erforderlich, da der Schematics-Arbeitsbereich über einen solchen verfügt.

Es gibt drei Szenarios:

Wenn nur ein locator_id angegeben wird, wird ein neuer Schematics-Arbeitsbereich mit diesem locator_id instanziiert.

Wenn nur ein Schema workspace_crn angegeben wird, wird ein 400 zurückgegeben, wenn kein locator_id im vorhandenen Schematics-Arbeitsbereich gefunden wird.

Wenn sowohl ein Schematics workspace_crn als auch ein locator_id angegeben sind, wird ein 400 Code zurückgegeben, wenn der angegebene locator_id nicht mit dem locator_id im vorhandenen Schematics Arbeitsbereich übereinstimmt.

--schematics-workspace-crn (Zeichenfolge)

Die maximale Länge beträgt 512 Zeichen. Die Mindestlänge beträgt 4 Zeichen. Der Wert muss dem regulären Ausdruck /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/ entsprechen.

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiele

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"}'

Alternativ sind differenzierte Optionen für die Unterfelder von JSON-Zeichenfolgeoptionen verfügbar:

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`

Ressourcen auflisten, die von einer Konfiguration implementiert werden.

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

Befehlsoptionen

--id (Zeichenfolge)

Die eindeutige Konfigurations-ID. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiel

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

Beispielausgabe

Die Beispielantwort auf eine Anforderung zum Abrufen von Projektkonfigurationsressourcen.

{
  "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`

Definiert Eingaben auf Stapelebene, die Benutzer zusammen mit Eingabewerten auf Mitgliedsebene konfigurieren müssen. Diese Werte werden in den Katalogeintrag aufgenommen, wenn der einsatzfähige Architekturstapel in einen privaten Katalog exportiert wird, und sind erforderlich, damit der einsatzfähige Architekturstapel eingesetzt werden kann. Ein Verweis kann zu einem Wert hinzugefügt werden, oder der Wert kann explizit auf der Ebene der Mitglieder hinzugefügt werden.

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]

Befehlsoptionen

--id (Zeichenfolge)

Die eindeutige Konfigurations-ID. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--stack-definition (StackDefinitionBlockPrototype)

Der Definitionsblock für eine Stackdefinition. Diese JSON-Option kann stattdessen bereitgestellt werden, indem einzelne Felder mit anderen Optionen festgelegt werden. Sie und diese Optionen schließen sich gegenseitig aus.

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

Definiert die Eingaben, die Benutzer auf Stapelebene konfigurieren müssen. Diese Eingaben sind im Katalogeintrag enthalten, wenn der implementierbare Architekturstack in einen privaten Katalog exportiert wird. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'stack-definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 300. Die Mindestlänge beträgt 0.

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

Die dieser Stackdefinition zugeordneten Ausgaben. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'stack-definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiele

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"}]}'

Alternativ sind differenzierte Optionen für die Unterfelder von JSON-Zeichenfolgeoptionen verfügbar:

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

Beispielausgabe

Beispielantwort von einer Operation zum Erstellen einer Stackvorlage

{
  "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`

Rufen Sie die Stackdefinition ab, die der Konfiguration zugeordnet ist.

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

Befehlsoptionen

--id (Zeichenfolge)

Die eindeutige Konfigurations-ID. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiel

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

Beispielausgabe

Beispielantwort von einer Operation zum Erstellen einer Stackvorlage

{
  "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`

Aktualisieren Sie die Stackdefinition, die der Konfiguration zugeordnet ist.

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]

Befehlsoptionen

--id (Zeichenfolge)

Die eindeutige Konfigurations-ID. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--stack-definition (StackDefinitionBlockPrototype)

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

Die maximale Länge beträgt 300. Die Mindestlänge beträgt 0.

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

Die dieser Stackdefinition zugeordneten Ausgaben. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'stack-definition' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiele

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"}]}'

Alternativ sind differenzierte Optionen für die Unterfelder von JSON-Zeichenfolgeoptionen verfügbar:

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

Beispielausgabe

Beispielantwort von einer Patch-Stack-Vorlagenoperation.

{
  "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`

Exportiert den implementierbaren Architekturstack in einen privaten Katalog. Alle implementierbaren Memberarchitekturen im Stack müssen validiert und implementiert werden, bevor der Stack exportiert wird. Die Stackdefinition muss ebenfalls vorhanden sein, bevor der Stack exportiert wird. Der Stapel kann als neues Produkt oder als neue Version eines bestehenden Produkts exportiert werden.

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]

Befehlsoptionen

--id (Zeichenfolge)

Die eindeutige Konfigurations-ID. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--settings (StackDefinitionExportRequest)

Die Nutzdaten für die Exportanforderung für privaten Katalog. Diese JSON-Option kann stattdessen bereitgestellt werden, indem einzelne Felder mit anderen Optionen festgelegt werden. Sie und diese Optionen schließen sich gegenseitig aus.

--settings-catalog-id (Zeichenfolge)

Die zu veröffentlichende Katalog-ID. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'settings' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\-0-9a-zA-Z]+$/ entsprechen.

--settings-target-version (Zeichenfolge)

Der Halbwertswert dieser neuen Version des Produkts. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'settings' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 60 Zeichen. Die Mindestlänge beträgt 5 Zeichen. Der Wert muss dem regulären Ausdruck /^(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-]+)*))?$/ entsprechen.

--settings-variation (Zeichenfolge)

Die Variante der aktuellen Software, die an Bord ist. Nur gültig, wenn die Produktart Modul oder Lösung ist. Siehe flavor im Importangebot des Katalogs. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'settings' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/ entsprechen.

--settings-label (Zeichenfolge)

Die Produktbezeichnung. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'settings' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/ entsprechen.

--settings-tags ([]zeichenfolge)

Dem Katalogprodukt zugeordnete Tags. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'settings' bereit. Sie und diese Option schließen sich gegenseitig aus.

Der Standardwert ist []. Die Listenelemente müssen dem regulären Ausdruck /^[a-zA-Z0-9][a-zA-Z0-9-_]*$/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--settings-product-id (Zeichenfolge)

Die zu veröffentlichende Produkt-ID. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'settings' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\-0-9a-zA-Z]+$/ entsprechen.

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--output (Zeichenfolge)

Wählen Sie ein Ausgabeformat - es kann 'json', 'yaml', 'tui' oder 'table' sein. (Standard: 'table')

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiele

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": []}'

Alternativ sind differenzierte Optionen für die Unterfelder von JSON-Zeichenfolgeoptionen verfügbar:

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 '[]'

Beispielausgabe

Beispielantwort vom Exportieren einer Stackdefinition in den privaten Katalog

{
  "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`

Ruft eine Liste vorheriger und aktueller Versionen einer Projektkonfiguration in einem bestimmten Projekt ab.

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

Befehlsoptionen

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Konfigurations-ID. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiel

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

Beispielausgabe

Die Beispielantwort auf eine Anfrage zum Auflisten von Projektkonfigurationsentwürfen

{
  "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"
  } ]
}

Standard-JMESPfad

Standard-JMESPfad
Antwort	Ausgabe	Abfrage
Erfolg	Standard
	Tabelle	`versions`
Fehler	Standard
	Tabelle	`versions`
Alle Seiten	Standard
	Tabelle	`versions`

Wenn eine benutzerdefinierte JMESPath-Abfrage angegeben wird, ersetzt sie alle JMESPaths in der obigen Tabelle.

`ibmcloud project config-version`

Ruft eine bestimmte Version einer Konfiguration in einem Projekt ab

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

Befehlsoptionen

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Konfigurations-ID. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--version (int64)

Die Konfigurationsversion. Erforderlich.

Der Höchstwert ist 10000. Der Mindestwert ist 0.

-q, --quiet (boolescher Wert)

Unterdrückt Nachrichten mit ausführlichen Informationen.

Beispiel

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

V2 Konfigurationen

Befehle für die Ressource V2Configurations.

`ibmcloud project config-version-delete`

Löschen Sie eine Konfigurationsversion, indem Sie die Projekt-ID angeben.

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

Befehlsoptionen

--project-id (Zeichenfolge)

Die eindeutige Projekt-ID. Erforderlich, wenn das Projekt nicht ausgewählt ist.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Konfigurations-ID. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Der Wert muss dem regulären Ausdruck /^[\\.\\-0-9a-zA-Z]+$/ entsprechen.

--version (int64)

Die Konfigurationsversion. Erforderlich.

Der Höchstwert ist 10000. Der Mindestwert ist 0.

Beispiel

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

Beispielausgabe

Die Beispielantwort auf eine Anfrage zum Löschen einer Konfiguration.

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

Schemabeispiele

Die folgenden Schemabeispiele stellen die Daten dar, die Sie für eine Befehlsoption angeben müssen. Diese Beispiele modellieren die Datenstruktur und umfassen Platzhalterwerte für den erwarteten Werttyp. Wenn Sie einen Befehl ausführen, ersetzen Sie diese Werte durch die Werte, die für Ihre Umgebung gelten.

EnvironmentDefinitionPropertiesPatch

Das folgende Beispiel zeigt das Format des Objekts 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

Das folgende Beispiel zeigt das Format des Objekts 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[]

Das folgende Beispiel zeigt das Format des Objekts EnvironmentPrototype[] .


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

ProjectComplianceProfile

Das folgende Beispiel zeigt das Format des Objekts 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

Das folgende Beispiel zeigt das Format des Objekts ProjectConfigAuth.


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

ProjectConfigDefinitionPatch

Das folgende Beispiel zeigt das Format des Objekts 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

Das folgende Beispiel zeigt das Format des Objekts 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[]

Das folgende Beispiel zeigt das Format des Objekts 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

Das folgende Beispiel zeigt das Format des Objekts 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

Das folgende Beispiel zeigt das Format des Objekts ProjectDefinitionStore.


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

ProjectPrototypeDefinition

Das folgende Beispiel zeigt das Format des Objekts 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

Das folgende Beispiel zeigt das Format des Objekts ProjectTerraformEngineSettings.


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

SchematicsWorkspace

Das folgende Beispiel zeigt das Format des Objekts SchematicsWorkspace.


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

StackDefinitionBlockPrototype

Das folgende Beispiel zeigt das Format des Objekts 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

Das folgende Beispiel zeigt das Format des Objekts StackDefinitionExportRequest.


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

StackDefinitionInputVariable

Das folgende Beispiel zeigt das Format des Objekts StackDefinitionInputVariable.


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

StackDefinitionOutputVariable

Das folgende Beispiel zeigt das Format des Objekts StackDefinitionOutputVariable.


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

StackMember

Das folgende Beispiel zeigt das Format des Objekts StackMember.


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

Weitere relevante Befehle für IBM Cloud-Projekte

Die folgenden Befehle sind nicht Teil des CLI-Plug-ins für Projekte, aber Sie können sie verwenden, um projektbezogene Tasks wie das Anhängen von Tags an ein Projekt auszuführen. Diese Liste enthält nicht alle relevanten Befehle, die für Projekte verfügbar sind. Diese Liste ist vielmehr ein Ausgangspunkt für das Durchsuchen anderer Befehle, die Sie mit Projekten verwenden können.

Einige der folgenden Befehle erfordern möglicherweise die Installation ihrer spezifischen Plug-ins, bevor Sie sie ausführen können.

Führen Sie ibmcloud resource tag-attach aus, um Tags an ein Projekt anzuhängen:

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

Ausführen ibmcloud resource search um alle Ressourcen in einem Konto abzurufen, das durch Konfigurationen in einem Projekt erstellt wurde:

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

Führen Sie ibmcloud schematics logs aus, um die Protokolldateien für einen Schematics-Arbeitsbereich abzurufen:

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