Referencia de CLI de proyecto

La interfaz de comando IBM Cloud® ( IBM Cloud CLI) proporciona capacidades adicionales para la oferta de servicios. Puede utilizar la CLI de IBM Cloud para gestionar los proyectos a los que tiene acceso.

Antes de empezar

Instale la CLI de IBM Cloud.
Instale la CLI del proyecto ejecutando el siguiente comando :

ibmcloud plugin install project

Se le notifica en la línea de mandatos cuando las actualizaciones de la CLI de IBM Cloud y los plug-ins están disponibles. Asegúrese de que mantiene actualizada la CLI para poder utilizar los mandatos más recientes. Puede ver la versión actual de todos los plugins instalados con el mandato ibmcloud plugin list.

Proyectos

Mandatos para el recurso Proyectos.

`ibmcloud project select`

Alias: target

Seleccione un proyecto como contexto actual.

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

Ejemplos

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

También puede seleccionar por nombre de proyecto

ibmcloud project select ProjectA

Para deseleccionar un proyecto

ibmcloud project select --unset-project

Opciones de comando

--unset-project (bool): Proyecto específico sin fijar
--output (cadena): Elija un formato de salida - puede ser 'json' o 'tabla'. (por defecto "tabla")
-q, --quiet (bool): Suprime los mensajes detallados.

ibmcloud project select --unset-project

`ibmcloud project create`

Cree un proyecto y configure de forma asíncrona las herramientas para gestionarlo. Añada una arquitectura desplegable personalizando la configuración. Una vez validados y aprobados los cambios, despliegue los recursos que configura el proyecto. Para obtener más información, consulte Creación de un proyecto.

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]

Opciones de comando

--definition (ProjectPrototypeDefinition)

La definición del proyecto. En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --definition=@path/to/file.json.

--location (cadena)

La ubicación de IBM Cloud donde se despliega un recurso. Obligatorio.

Los valores permitidos son: us-south, us-east, eu-gb, eu-de, ca-tor.

--resource-group (cadena)

El nombre del grupo de recursos donde se crean los datos y las herramientas del proyecto. Obligatorio.

La longitud máxima es de 64 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/.

--configs (ProjectConfigPrototype[])

Las configuraciones del proyecto. Estas configuraciones se incluyen en la respuesta de crear un proyecto sólo si se especifica una matriz de configuración en la carga útil de solicitud.

El valor predeterminado es []. La longitud máxima es de 100 elementos. La longitud mínima es de 0 artículos.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --configs=@path/to/file.json.

--environments (EnvironmentPrototype[])

Entorno del proyecto. Estos entornos se incluyen en la respuesta de crear un proyecto sólo si se especifica una matriz de entorno en la carga útil de solicitud.

El valor predeterminado es []. La longitud máxima es de 20 elementos. La longitud mínima es de 0 artículos.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --environments=@path/to/file.json.

--definition-name (cadena)

El nombre del proyecto. Es exclusivo dentro de la cuenta entre regiones. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 128 caracteres. La longitud mínima es de 1 caracteres. El valor debe coincidir con la expresión regular /^(?!\\s)(?!.*\\s$)[^'"`\/<>{}\\x00-\\x1F]+$/.

--definition-description (cadena)

Una breve explicación del uso del proyecto en la configuración de una arquitectura desplegable. Se puede crear un proyecto sin proporcionar una descripción. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

El valor predeterminado es . La longitud máxima es de 1024 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.

--definition-auto-deploy-mode (cadena)

Esta es una configuración avanzada del despliegue automático para indicar cómo debe comportarse el despliegue automático cuando está activado. Existen dos opciones:

auto_approval aprobará automáticamente la configuración una vez validada sin confirmación del usuario.

manual_approval requerirá la confirmación del usuario para aprobar la configuración una vez validada antes de iniciar el despliegue de la configuración. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

El valor predeterminado es manual_approval. Los valores permitidos son: auto_approval, manual_approval.

--definition-monitoring-enabled (bool)

Un distintivo booleano para habilitar la detección automática de desviación. Utilice este campo para ejecutar una comprobación diaria y comparar las configuraciones con los recursos desplegados para detectar cualquier diferencia. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

El valor predeterminado es false.

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

La política que indica si se anula el despliegue de los recursos o no cuando se suprime un proyecto. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

El valor predeterminado es true.

--definition-store (ProjectDefinitionStore)

Los detalles necesarios para almacenar de forma personalizada las configuraciones del proyecto. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --definition-store=@path/to/file.json.

--definition-terraform-engine (ProjectTerraformEngineSettings)

Esquema experimental: con fines de creación de prototipos. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --definition-terraform-engine=@path/to/file.json.

--definition-auto-deploy (bool)

Un indicador booleano para activar el despliegue automático de configuraciones. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

El valor predeterminado es false.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplos

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

De forma alternativa, las opciones granulares están disponibles para los subcampos de las opciones de serie JSON:

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

`ibmcloud project list`

Listar proyectos existentes. Los proyectos se ordenan por ID. Nota: Si no se establece la opción --all-pages, el comando sólo recuperará una única página de la colección.

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

Opciones de comando

--token (cadena)

El servidor utiliza este parámetro para determinar la primera entrada que se devuelve en la página siguiente. Si no se especifica este parámetro, se devuelve la primera página lógica.

El valor predeterminado es . La longitud máxima es de 1536 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.

--limit (int64)

El número máximo de recursos a devolver. El número de recursos que se devuelven es el mismo, excepto para la última página.

El valor predeterminado es 10. El valor máximo es 100. El valor mínimo es 1.

--all-pages (bool)

Invocar múltiples peticiones para mostrar todas las páginas de la colección para la lista.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplo

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

Salida de ejemplo

Una solicitud de ejemplo para listar proyectos.

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

JMESPath por defecto

Se aplicará una consulta JMESPath a la salida de este comando por defecto, si el usuario no proporciona una. La consulta exacta dependerá del escenario y del formato de salida solicitado. Puede ver la condición para cada consulta JMESPath por defecto en la siguiente tabla:

JMESPath por defecto
Respuesta	Salida	Consulta
Correcto	Valor predeterminado
	Tabla	`projects[].{id: id, name: definition.name, state: state}`
Error	Valor predeterminado
	Tabla	`projects[].{id: id, name: definition.name, state: state}`
Todas las páginas	Valor predeterminado
	Tabla	`projects[].{id: id, name: definition.name, state: state}`

Si se proporciona una consulta JMESPath personalizada, ésta sustituirá a cualquiera de las JMESPath de la tabla anterior.

`ibmcloud project get`

Obtener información sobre un proyecto.

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

Opciones de comando

--id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

Ejemplo

ibmcloud project get \
    --id exampleString

Salida de ejemplo

Una respuesta de ejemplo para recuperar un proyecto con configuraciones.

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

JMESPath por defecto

JMESPath por defecto
Respuesta	Salida	Consulta
Correcto	Valor predeterminado
	Tabla	`{id: id, name: definition.name, state: state}`
Error	Valor predeterminado
	Tabla	`{id: id, name: definition.name, state: state}`
Todas las páginas	Valor predeterminado
	Tabla	`{id: id, name: definition.name, state: state}`

Si se proporciona una consulta JMESPath personalizada, ésta sustituirá a cualquiera de las JMESPath de la tabla anterior.

`ibmcloud project update`

Actualizar un proyecto especificando su ID.

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

Opciones de comando

--id (cadena)

El ID de proyecto exclusivo. Obligatorio si no se selecciona el proyecto.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--definition (ProjectDefinitionPatch)

La definición del proyecto. En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --definition=@path/to/file.json.

--definition-name (cadena)

El nombre del proyecto. Es exclusivo dentro de la cuenta entre regiones. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 128 caracteres. La longitud mínima es de 1 caracteres. El valor debe coincidir con la expresión regular /^(?!\\s)(?!.*\\s$)[^'"`\/<>{}\\x00-\\x1F]+$/.

--definition-description (cadena)

La longitud máxima es de 1024 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.

--definition-auto-deploy-mode (cadena)

Esta es una configuración avanzada del despliegue automático para indicar cómo debe comportarse el despliegue automático cuando está activado. Existen dos opciones:

auto_approval aprobará automáticamente la configuración una vez validada sin confirmación del usuario.

manual_approval requerirá la confirmación del usuario para aprobar la configuración una vez validada antes de iniciar el despliegue de la configuración. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

Los valores permitidos son: auto_approval, manual_approval.

--definition-monitoring-enabled (bool)

Un distintivo booleano para habilitar la detección automática de desviación. Utilice este campo para ejecutar una comprobación diaria para comparar las configuraciones con los recursos desplegados y detectar cualquier diferencia. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

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

--definition-store (ProjectDefinitionStore)

--definition-terraform-engine (ProjectTerraformEngineSettings)

Esquema experimental: con fines de creación de prototipos. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

--definition-auto-deploy (bool)

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplos

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

De forma alternativa, las opciones granulares están disponibles para los subcampos de las opciones de serie JSON:

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

Salida de ejemplo

Una respuesta de ejemplo para recuperar un proyecto con configuraciones.

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

Suprima un documento de proyecto especificando el ID. Un proyecto sólo puede borrarse después de haber borrado todos sus recursos.

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

Opciones de comando

--id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

Ejemplo

ibmcloud project delete \
    --id exampleString

Salida de ejemplo

Respuesta de ejemplo a una solicitud para suprimir un proyecto.

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

Entornos

Mandatos para el recurso Entornos.

`ibmcloud project environment-create`

Cree un entorno para agrupar configuraciones relacionadas y compartir valores entre ellas para facilitar el despliegue. Para obtener más información, consulte Creación de un entorno.

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]

Opciones de comando

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--definition (EnvironmentDefinitionRequiredProperties)

La definición de entorno. En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --definition=@path/to/file.json.

--definition-description (cadena)

La descripción del entorno. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

--definition-name (cadena)

El nombre del entorno. Es exclusivo dentro de la cuenta entre proyectos y regiones. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 128 caracteres. La longitud mínima es de 1 caracteres. El valor debe coincidir con la expresión regular /^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]+$/.

--definition-authorizations (ProjectConfigAuth)

Los detalles de autorización. Puede autorizar utilizando un perfil de confianza o una clave de API en Secrets Manager. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --definition-authorizations=@path/to/file.json.

--definition-inputs (correlación genérica)

Las variables de entrada que se utilizan para la definición de configuración y el entorno. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --definition-inputs=@path/to/file.json.

--definition-compliance-profile (ProjectComplianceProfile)

El perfil necesario para la conformidad. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --definition-compliance-profile=@path/to/file.json.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplos

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

De forma alternativa, las opciones granulares están disponibles para los subcampos de las opciones de serie JSON:

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

Salida de ejemplo

La respuesta de entorno de ejemplo.

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

Listar todos los entornos disponibles. Para obtener más información, consulte Creación de un entorno. Nota: Si no se establece la opción --all-pages, el comando sólo recuperará una única página de la colección.

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

Opciones de comando

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--token (cadena)

El servidor utiliza este parámetro para determinar la primera entrada que se devuelve en la página siguiente. Si no se especifica este parámetro, se devuelve la primera página lógica.

--limit (int64)

El número máximo de recursos a devolver. El número de recursos que se devuelven es el mismo, excepto para la última página.

El valor predeterminado es 10. El valor máximo es 100. El valor mínimo es 1.

--all-pages (bool)

Invocar múltiples peticiones para mostrar todas las páginas de la colección para entornos.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplo

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

Salida de ejemplo

La respuesta de entorno de ejemplo para una lista.

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

Obtener un entorno. Más información.

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

Opciones de comando

--id (cadena)

El ID de entorno. Obligatorio.

La longitud máxima es de 256 caracteres. La longitud mínima es de 1 caracteres. El valor debe coincidir con la expresión regular /^(?!\\s)(?!.*\\s$).+$/.

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplo

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

Salida de ejemplo

La respuesta de entorno de ejemplo.

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

Actualice un entorno especificando su ID. Más información.

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]

Opciones de comando

--id (cadena)

El ID de entorno. Obligatorio.

La longitud máxima es de 256 caracteres. La longitud mínima es de 1 caracteres. El valor debe coincidir con la expresión regular /^(?!\\s)(?!.*\\s$).+$/.

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--definition (EnvironmentDefinitionPropertiesPatch)

La definición de entorno que se utiliza para las actualizaciones. En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --definition=@path/to/file.json.

--definition-description (cadena)

La descripción del entorno. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 1024 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.

--definition-name (cadena)

La longitud máxima es de 128 caracteres. La longitud mínima es de 1 caracteres. El valor debe coincidir con la expresión regular /^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]+$/.

--definition-authorizations (ProjectConfigAuth)

--definition-inputs (correlación genérica)

--definition-compliance-profile (ProjectComplianceProfile)

El perfil necesario para la conformidad. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplos

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

De forma alternativa, las opciones granulares están disponibles para los subcampos de las opciones de serie JSON:

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

Salida de ejemplo

La respuesta de entorno de ejemplo.

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

Suprimir un entorno en un proyecto especificando su ID.

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

Opciones de comando

--id (cadena)

El ID de entorno. Obligatorio.

La longitud máxima es de 256 caracteres. La longitud mínima es de 1 caracteres. El valor debe coincidir con la expresión regular /^(?!\\s)(?!.*\\s$).+$/.

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplo

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

Salida de ejemplo

La respuesta de eliminación del entorno de muestra.

{
  "id" : "env123"
}

Configuraciones

Mandatos para el recurso Configuraciones.

`ibmcloud project config-create`

Añade una nueva configuración a un proyecto.

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]

Opciones de comando

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--definition (ProjectConfigDefinitionPrototype)

En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --definition=@path/to/file.json.

--schematics (SchematicsWorkspace)

Un espacio de trabajo de Schematics para utilizar para desplegar esta arquitectura desplegable.

Si se importan datos de un espacio de trabajo Schematics existente que no esté respaldado por un carro, se debe proporcionar un locator_id. Si se utiliza un espacio de trabajo Schematics respaldado por cart, no es necesario un locator_id porque el espacio de trabajo Schematics dispone de uno.

Hay 3 escenarios:

Si solo se especifica un locator_id, se crea una instancia de un nuevo espacio de trabajo de Schematics con ese locator_id.

Si solo se especifica un workspace_crn de schematics, se devuelve un 400 si no se encuentra un locator_id en el espacio de trabajo de schematics existente.

Si se especifican tanto un Schematics workspace_crn como un locator_id, se devuelve un código 400 si el locator_id especificado no coincide con el locator_id del espacio de trabajo Schematics existente.

Para obtener más información, consulte Creación de espacios de trabajo e importación de la plantilla de Terraform. En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --schematics=@path/to/file.json.

--definition-compliance-profile (ProjectComplianceProfile)

El perfil necesario para la conformidad. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

--definition-locator-id (cadena)

Una concatenación exclusiva del ID de catálogo y el ID de versión que identifican la arquitectura desplegable en el catálogo. Si se importa desde un espacio de trabajo Schematics existente que no está respaldado por cart, se requiere un locator_id. Si se utiliza un espacio de trabajo Schematics que está respaldado por cart, no es necesario un locator_id porque el espacio de trabajo Schematics tiene uno.

Hay 3 escenarios:

Si solo se especifica un locator_id, se crea una instancia de un nuevo espacio de trabajo de Schematics con ese locator_id.

Si solo se especifica un workspace_crn de schematics, se devuelve un 400 si no se encuentra un locator_id en el espacio de trabajo de schematics existente.

Si se especifican tanto Schematics workspace_crn como locator_id, se devuelve un mensaje 400 si el locator_id especificado no está de acuerdo con el locator_id en el espacio de trabajo Schematics existente. Para obtener más información sobre la creación de un espacio de trabajo Schematics, consulte Creación de espacios de trabajo e importación de la plantilla Terraform. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 512 caracteres. La longitud mínima es de 1 caracteres. El valor debe coincidir con la expresión regular /^(?!\\s)(?!.*\\s$)[\\.0-9a-z-A-Z_-]+$/.

--definition-members (StackMember[])

Las arquitecturas desplegables miembros que se incluyen en la pila. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 100 elementos. La longitud mínima es de 0 artículos.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --definition-members=@path/to/file.json.

--definition-uses (ProjectConfigUses[])

Las arquitecturas deployabe dependientes a las que hace referencia esta configuración. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 100 elementos. La longitud mínima es de 0 artículos.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --definition-uses=@path/to/file.json.

--definition-description (cadena)

Una descripción de configuración de proyecto. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

--definition-name (cadena)

Nombre de la configuración. Es exclusivo dentro de la cuenta entre proyectos y regiones. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 128 caracteres. La longitud mínima es de 1 caracteres. El valor debe coincidir con la expresión regular /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.

--definition-authorizations (ProjectConfigAuth)

Los detalles de autorización. Puede autorizar utilizando un perfil de confianza o una clave API en Secrets Manager. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

--definition-inputs (correlación genérica)

--definition-settings (correlación genérica)

Las variables de entorno de Schematics que se van a utilizar para desplegar la configuración. Los valores sólo están disponibles si se especifican cuando se crea inicialmente la configuración. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --definition-settings=@path/to/file.json.

--definition-environment-id (cadena)

El ID del entorno del proyecto. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

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

Los CRN de los recursos que están asociados con esta configuración. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

Los elementos de la lista deben coincidir con la expresión regular /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/. La longitud máxima es de 110 elementos. La longitud mínima es de 0 artículos.

--schematics-workspace-crn (cadena)

Un nombre de recurso de IBM Cloud que identifica de forma exclusiva un recurso. Esta opción proporciona un valor para un subcampo de la opción JSON 'schematics'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 512 caracteres. La longitud mínima es de 4 caracteres. El valor debe coincidir con la expresión regular /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplos

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

De forma alternativa, las opciones granulares están disponibles para los subcampos de las opciones de serie JSON:

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

`ibmcloud project configs`

Recuperar la colección de configuraciones. Nota: Si no se establece la opción --all-pages, el comando sólo recuperará una única página de la colección.

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

Opciones de comando

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--token (cadena)

El servidor utiliza este parámetro para determinar la primera entrada que se devuelve en la página siguiente. Si no se especifica este parámetro, se devuelve la primera página lógica.

--limit (int64)

El número máximo de recursos a devolver. El número de recursos que se devuelven es el mismo, excepto para la última página.

El valor predeterminado es 10. El valor máximo es 100. El valor mínimo es 1.

--all-pages (bool)

Invoca múltiples peticiones para mostrar todas las páginas de la colección de configuraciones.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplo

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

Salida de ejemplo

La respuesta de ejemplo para una solicitud para obtener configuraciones de proyecto.

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

JMESPath por defecto

JMESPath por defecto
Respuesta	Salida	Consulta
Correcto	Valor predeterminado
	Tabla	`configs[].{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`
Error	Valor predeterminado
	Tabla	`configs[].{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`
Todas las páginas	Valor predeterminado
	Tabla	`configs[].{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`

Si se proporciona una consulta JMESPath personalizada, ésta sustituirá a cualquiera de las JMESPath de la tabla anterior.

`ibmcloud project config`

Recuperar la configuración de proyecto especificada en un proyecto específico.

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

Opciones de comando

--id (cadena)

El ID de configuración exclusivo. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

Ejemplo

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

JMESPath por defecto

JMESPath por defecto
Respuesta	Salida	Consulta
Correcto	Valor predeterminado
	Tabla	`{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`
Error	Valor predeterminado
	Tabla	`{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`
Todas las páginas	Valor predeterminado
	Tabla	`{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`

Si se proporciona una consulta JMESPath personalizada, ésta sustituirá a cualquiera de las JMESPath de la tabla anterior.

`ibmcloud project config-update`

Actualice una configuración en un proyecto especificando el ID. Más información.

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]

Opciones de comando

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--id (cadena)

El ID de configuración exclusivo. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--definition (ProjectConfigDefinitionPatch)

En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --definition=@path/to/file.json.

--definition-compliance-profile (ProjectComplianceProfile)

El perfil necesario para la conformidad. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

--definition-locator-id (cadena)

Hay 3 escenarios:

Si solo se especifica un locator_id, se crea una instancia de un nuevo espacio de trabajo de Schematics con ese locator_id.

Si solo se especifica un workspace_crn de schematics, se devuelve un 400 si no se encuentra un locator_id en el espacio de trabajo de schematics existente.

Si se especifican tanto Schematics workspace_crn como locator_id, se devuelve un mensaje 400 si el locator_id especificado no está de acuerdo con el locator_id en el espacio de trabajo Schematics existente. Para obtener más información sobre la creación de un espacio de trabajo Schematics, consulte Creación de espacios de trabajo e importación de la plantilla Terraform. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 512 caracteres. La longitud mínima es de 1 caracteres. El valor debe coincidir con la expresión regular /^(?!\\s)(?!.*\\s$)[\\.0-9a-z-A-Z_-]+$/.

--definition-members (StackMember[])

Las arquitecturas desplegables miembros que se incluyen en la pila. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 100 elementos. La longitud mínima es de 0 artículos.

--definition-uses (ProjectConfigUses[])

La longitud máxima es de 100 elementos. La longitud mínima es de 0 artículos.

--definition-description (cadena)

Una descripción de configuración de proyecto. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 1024 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.

--definition-name (cadena)

La longitud máxima es de 128 caracteres. La longitud mínima es de 1 caracteres. El valor debe coincidir con la expresión regular /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.

--definition-authorizations (ProjectConfigAuth)

--definition-inputs (correlación genérica)

--definition-settings (correlación genérica)

--definition-environment-id (cadena)

El ID del entorno del proyecto. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

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

Los CRN de los recursos que están asociados con esta configuración. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplos

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

De forma alternativa, las opciones granulares están disponibles para los subcampos de las opciones de serie JSON:

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

`ibmcloud project config-delete`

Suprimir una configuración en un proyecto especificando su ID.

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

Opciones de comando

--id (cadena)

El ID de configuración exclusivo. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

Ejemplo

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

Salida de ejemplo

La respuesta de ejemplo a una solicitud para suprimir una configuración.

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

`ibmcloud project config-force-approve`

Forzar la aprobación de ediciones de configuración en la configuración principal con un comentario de aprobación.

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

Opciones de comando

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--id (cadena)

El ID de configuración exclusivo. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--comment (cadena)

Notas sobre el proyecto de acción. Si esta acción es forzar aprobación en el borrador de configuración, debe incluir un comentario no vacío. Obligatorio.

La longitud máxima es de 1024 caracteres. La longitud mínima es de 1 caracteres. El valor debe coincidir con la expresión regular /^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]+$/.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplo

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

Salida de ejemplo

La respuesta de ejemplo a una solicitud para un borrador de configuración de arquitectura desplegable.

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

Aprobar y fusionar ediciones de configuración en la configuración principal.

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

Opciones de comando

--id (cadena)

El ID de configuración exclusivo. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--comment (cadena)

Notas sobre el proyecto de acción. Si esta acción es forzar aprobación en el borrador de configuración, debe incluir un comentario no vacío.

La longitud máxima es de 1024 caracteres. La longitud mínima es de 1 caracteres. El valor debe coincidir con la expresión regular /^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]+$/.

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplo

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

Salida de ejemplo

La respuesta de ejemplo a una solicitud para un borrador de configuración de arquitectura desplegable.

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

Ejecute una comprobación de validación en una configuración específica del proyecto. La comprobación incluye la creación o actualización del espacio de trabajo Schematics asociado con un trabajo de plan, la ejecución de las exploraciones de CRA y la estimación de costes.

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

Opciones de comando

--id (cadena)

El ID de configuración exclusivo. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplo

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

Salida de ejemplo

La respuesta de ejemplo a una solicitud para un borrador de configuración de arquitectura desplegable.

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

Ejecuta una comprobación de validación de una configuración pasada a través de la API. La comprobación incluye la creación de un espacio de trabajo Schematics con un trabajo de planificación, la ejecución de las exploraciones CRA y la estimación de costes.

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]

Opciones de comando

--id (cadena)

El ID de configuración exclusivo. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--definition (ProjectConfigDefinitionPrototype)

En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --definition=@path/to/file.json.

--schematics (SchematicsWorkspace)

Un espacio de trabajo de Schematics para utilizar para desplegar esta arquitectura desplegable.

Si se importan datos de un espacio de trabajo Schematics existente que no esté respaldado por un carro, se debe proporcionar un locator_id. Si se utiliza un espacio de trabajo Schematics respaldado por cart, no es necesario un locator_id porque el espacio de trabajo Schematics dispone de uno.

Hay 3 escenarios:

Si solo se especifica un locator_id, se crea una instancia de un nuevo espacio de trabajo de Schematics con ese locator_id.

Si solo se especifica un workspace_crn de schematics, se devuelve un 400 si no se encuentra un locator_id en el espacio de trabajo de schematics existente.

Si se especifican tanto un Schematics workspace_crn como un locator_id, se devuelve un código 400 si el locator_id especificado no coincide con el locator_id del espacio de trabajo Schematics existente.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --schematics=@path/to/file.json.

--definition-compliance-profile (ProjectComplianceProfile)

El perfil necesario para la conformidad. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

--definition-locator-id (cadena)

Hay 3 escenarios:

Si solo se especifica un locator_id, se crea una instancia de un nuevo espacio de trabajo de Schematics con ese locator_id.

Si solo se especifica un workspace_crn de schematics, se devuelve un 400 si no se encuentra un locator_id en el espacio de trabajo de schematics existente.

Si se especifican tanto Schematics workspace_crn como locator_id, se devuelve un mensaje 400 si el locator_id especificado no está de acuerdo con el locator_id en el espacio de trabajo Schematics existente. Para obtener más información sobre la creación de un espacio de trabajo Schematics, consulte Creación de espacios de trabajo e importación de la plantilla Terraform. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 512 caracteres. La longitud mínima es de 1 caracteres. El valor debe coincidir con la expresión regular /^(?!\\s)(?!.*\\s$)[\\.0-9a-z-A-Z_-]+$/.

--definition-members (StackMember[])

Las arquitecturas desplegables miembros que se incluyen en la pila. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 100 elementos. La longitud mínima es de 0 artículos.

--definition-uses (ProjectConfigUses[])

La longitud máxima es de 100 elementos. La longitud mínima es de 0 artículos.

--definition-description (cadena)

Una descripción de configuración de proyecto. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

--definition-name (cadena)

La longitud máxima es de 128 caracteres. La longitud mínima es de 1 caracteres. El valor debe coincidir con la expresión regular /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.

--definition-authorizations (ProjectConfigAuth)

--definition-inputs (correlación genérica)

--definition-settings (correlación genérica)

--definition-environment-id (cadena)

El ID del entorno del proyecto. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

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

Los CRN de los recursos que están asociados con esta configuración. Esta opción proporciona un valor para un subcampo de la opción JSON 'definition'. Es mutuamente excluyente con esa opción.

--schematics-workspace-crn (cadena)

La longitud máxima es de 512 caracteres. La longitud mínima es de 4 caracteres. El valor debe coincidir con la expresión regular /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplos

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

De forma alternativa, las opciones granulares están disponibles para los subcampos de las opciones de serie JSON:

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

Salida de ejemplo

El objeto de resultado para prevalidar.

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

`ibmcloud project get-prevalidate`

Recuperar los resultados de la prevalidación mediante una clave.

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

Opciones de comando

--id (cadena)

El ID de configuración exclusivo. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--result-id (cadena)

El identificador único para obtener eventos de prevalidación. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplo

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

Salida de ejemplo

Un ejemplo de respuesta para obtener resultados prevalidados.

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

Desplegar la configuración de un proyecto. Esta operación es asíncrona y puede seguirse utilizando la API de obtención de la configuración del proyecto con los metadatos completos.

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

Opciones de comando

--id (cadena)

El ID de configuración exclusivo. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplo

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

Salida de ejemplo

La respuesta de ejemplo a una solicitud para un borrador de configuración de arquitectura desplegable.

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

Anular el despliegue de los recursos de configuración de un proyecto. La operación anula el despliegue de todos los recursos que se despliegan con la configuración específica. Los recursos de configuración pueden rastrearse utilizando la API de obtención de configuración del proyecto con metadatos completos.

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

Opciones de comando

--id (cadena)

El ID de configuración exclusivo. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplo

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

Salida de ejemplo

La respuesta de ejemplo a una solicitud para un borrador de configuración de arquitectura desplegable.

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

Sincronice una configuración de proyecto analizando las ejecuciones de interconexión asociadas y los registros del espacio de trabajo Schematics para que la configuración vuelva a un estado de trabajo.

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

Opciones de comando

--id (cadena)

El ID de configuración exclusivo. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--schematics (SchematicsWorkspace)

Un espacio de trabajo de Schematics para utilizar para desplegar esta arquitectura desplegable.

Si se importan datos de un espacio de trabajo Schematics existente que no esté respaldado por un carro, se debe proporcionar un locator_id. Si se utiliza un espacio de trabajo Schematics respaldado por cart, no es necesario un locator_id porque el espacio de trabajo Schematics dispone de uno.

Hay 3 escenarios:

Si solo se especifica un locator_id, se crea una instancia de un nuevo espacio de trabajo de Schematics con ese locator_id.

Si solo se especifica un workspace_crn de schematics, se devuelve un 400 si no se encuentra un locator_id en el espacio de trabajo de schematics existente.

Si se especifican tanto un Schematics workspace_crn como un locator_id, se devuelve un código 400 si el locator_id especificado no coincide con el locator_id del espacio de trabajo Schematics existente.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --schematics=@path/to/file.json.

--schematics-workspace-crn (cadena)

La longitud máxima es de 512 caracteres. La longitud mínima es de 4 caracteres. El valor debe coincidir con la expresión regular /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/.

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplos

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

De forma alternativa, las opciones granulares están disponibles para los subcampos de las opciones de serie JSON:

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

`ibmcloud project config-resources`

Lista los recursos desplegados por una configuración.

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

Opciones de comando

--id (cadena)

El ID de configuración exclusivo. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplo

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

Salida de ejemplo

La respuesta de ejemplo a una solicitud para obtener recursos de configuración de proyecto.

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

Define las entradas a nivel de pila que los usuarios deben configurar junto con los valores de entrada a nivel de miembro. Estos valores se incluyen en la entrada del catálogo cuando la pila de arquitectura desplegable se exporta a un catálogo privado y son necesarios para que la pila de arquitectura desplegable se despliegue. Se puede añadir una referencia a un valor, o añadir el valor explícitamente a nivel de miembro.

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]

Opciones de comando

--id (cadena)

El ID de configuración exclusivo. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--stack-definition (StackDefinitionBlockPrototype)

El bloque de definición para una definición de pila. En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --stack-definition=@path/to/file.json.

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

Define las entradas que los usuarios necesitan configurar en el nivel de pila. Estas entradas se incluyen en la entrada de catálogo cuando la pila de arquitectura desplegable se exporta a un catálogo privado. Esta opción proporciona un valor para un subcampo de la opción JSON 'stack-definition'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 300 elementos. La longitud mínima es de 0 artículos.

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

Las salidas asociadas a esta definición de pila. Esta opción proporciona un valor para un subcampo de la opción JSON 'stack-definition'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 100 elementos. La longitud mínima es de 0 artículos.

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplos

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

De forma alternativa, las opciones granulares están disponibles para los subcampos de las opciones de serie JSON:

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

Salida de ejemplo

Respuesta de ejemplo de una operación de creación de plantilla de pila.

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

Recupere la definición de pila asociada a la configuración.

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

Opciones de comando

--id (cadena)

El ID de configuración exclusivo. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplo

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

Salida de ejemplo

Respuesta de ejemplo de una operación de creación de plantilla de pila.

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

Actualice la definición de pila que está asociada con la configuración.

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]

Opciones de comando

--id (cadena)

El ID de configuración exclusivo. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--stack-definition (StackDefinitionBlockPrototype)

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

La longitud máxima es de 300 elementos. La longitud mínima es de 0 artículos.

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

Las salidas asociadas a esta definición de pila. Esta opción proporciona un valor para un subcampo de la opción JSON 'stack-definition'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 100 elementos. La longitud mínima es de 0 artículos.

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplos

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

De forma alternativa, las opciones granulares están disponibles para los subcampos de las opciones de serie JSON:

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

Salida de ejemplo

Respuesta de ejemplo de una operación de plantilla de pila de parches.

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

Exporta la pila de arquitectura desplegable a un catálogo privado. Todas las arquitecturas desplegables de miembros dentro de la pila deben validarse y desplegarse antes de exportar la pila. La definición de pila también debe existir antes de exportar la pila. La pila puede exportarse como un nuevo producto o como una nueva versión de un producto existente.

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]

Opciones de comando

--id (cadena)

El ID de configuración exclusivo. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--settings (StackDefinitionExportRequest)

La carga útil para la solicitud de exportación de catálogo privado. En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que empiece por @, por ejemplo --settings=@path/to/file.json.

--settings-catalog-id (cadena)

El ID de catálogo a publicar. Esta opción proporciona un valor para un subcampo de la opción JSON 'settings'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 36 caracteres. El valor debe coincidir con la expresión regular /^[\\-0-9a-zA-Z]+$/.

--settings-target-version (cadena)

El valor semver de esta nueva versión del producto. Esta opción proporciona un valor para un subcampo de la opción JSON 'settings'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 60 caracteres. La longitud mínima es de 5 caracteres. El valor debe coincidir con la expresión regular /^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$/.

--settings-variation (cadena)

La variación del software actual que se está incorporando. Sólo válido si el tipo de producto es módulo o solución. Consulte flavor en la oferta de importación de Catalog. Esta opción proporciona un valor para un subcampo de la opción JSON 'settings'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.

--settings-label (cadena)

La etiqueta del producto. Esta opción proporciona un valor para un subcampo de la opción JSON 'settings'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.

--settings-tags (serie[])

Etiquetas asociadas con el producto de catálogo. Esta opción proporciona un valor para un subcampo de la opción JSON 'settings'. Es mutuamente excluyente con esa opción.

El valor predeterminado es []. Los elementos de la lista deben coincidir con la expresión regular /^[a-zA-Z0-9][a-zA-Z0-9-_]*$/. La longitud máxima es de 10 elementos. La longitud mínima es de 0 artículos.

--settings-product-id (cadena)

El ID de producto a publicar. Esta opción proporciona un valor para un subcampo de la opción JSON 'settings'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 36 caracteres. El valor debe coincidir con la expresión regular /^[\\-0-9a-zA-Z]+$/.

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (cadena)

Elija un formato de salida - puede ser 'json', 'yaml', 'tui', o 'table'. (por defecto "tabla")

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplos

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

De forma alternativa, las opciones granulares están disponibles para los subcampos de las opciones de serie JSON:

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

Salida de ejemplo

Respuesta de ejemplo de la exportación de una definición de pila al catálogo privado

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

Recuperar una lista de versiones anteriores y actuales de una configuración de proyecto en un proyecto específico.

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

Opciones de comando

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--id (cadena)

El ID de configuración exclusivo. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplo

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

Salida de ejemplo

La respuesta de ejemplo a una solicitud para listar borradores de configuración de proyecto.

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

JMESPath por defecto

JMESPath por defecto
Respuesta	Salida	Consulta
Correcto	Valor predeterminado
	Tabla	`versions`
Error	Valor predeterminado
	Tabla	`versions`
Todas las páginas	Valor predeterminado
	Tabla	`versions`

Si se proporciona una consulta JMESPath personalizada, ésta sustituirá a cualquiera de las JMESPath de la tabla anterior.

`ibmcloud project config-version`

Recuperar una versión específica de una configuración en un proyecto.

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

Opciones de comando

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--id (cadena)

El ID de configuración exclusivo. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--version (int64)

La versión de configuración. Obligatorio.

El valor máximo es 10000. El valor mínimo es 0.

-q, --quiet (bool)

Suprime los mensajes detallados.

Ejemplo

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

V2 Configuraciones

Comandos para el recurso V2Configurations.

`ibmcloud project config-version-delete`

Suprima una versión de configuración especificando el ID de proyecto.

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

Opciones de comando

--project-id (cadena)

El ID de proyecto exclusivo. Obligatorio si el proyecto no está seleccionado.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--id (cadena)

El ID de configuración exclusivo. Obligatorio.

La longitud máxima es de 128 caracteres. El valor debe coincidir con la expresión regular /^[\\.\\-0-9a-zA-Z]+$/.

--version (int64)

La versión de configuración. Obligatorio.

El valor máximo es 10000. El valor mínimo es 0.

Ejemplo

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

Salida de ejemplo

La respuesta de ejemplo a una solicitud para suprimir una configuración.

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

Ejemplos de esquema

Los ejemplos de esquema siguientes representan los datos que debe especificar para una opción de mandato. Estos ejemplos modelan la estructura de datos e incluyen valores de marcador para el tipo de valor esperado. Cuando ejecute un mandato, sustituya estos valores por los valores que se aplican a su entorno según corresponda.

EnvironmentDefinitionPropertiesPatch

El siguiente ejemplo muestra el formato del objeto 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

El siguiente ejemplo muestra el formato del objeto 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[]

El siguiente ejemplo muestra el formato del objeto EnvironmentPrototype[] .


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

ProjectComplianceProfile

El siguiente ejemplo muestra el formato del objeto 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

El siguiente ejemplo muestra el formato del objeto ProjectConfigAuth.


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

ProjectConfigDefinitionPatch

El siguiente ejemplo muestra el formato del objeto 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

El siguiente ejemplo muestra el formato del objeto 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[]

El siguiente ejemplo muestra el formato del objeto 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

El siguiente ejemplo muestra el formato del objeto 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

El siguiente ejemplo muestra el formato del objeto ProjectDefinitionStore.


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

ProjectPrototypeDefinition

El siguiente ejemplo muestra el formato del objeto 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

El siguiente ejemplo muestra el formato del objeto ProjectTerraformEngineSettings.


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

SchematicsWorkspace

El siguiente ejemplo muestra el formato del objeto SchematicsWorkspace.


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

StackDefinitionBlockPrototype

El siguiente ejemplo muestra el formato del objeto 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

El siguiente ejemplo muestra el formato del objeto StackDefinitionExportRequest.


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

StackDefinitionInputVariable

El siguiente ejemplo muestra el formato del objeto StackDefinitionInputVariable.


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

StackDefinitionOutputVariable

El siguiente ejemplo muestra el formato del objeto StackDefinitionOutputVariable.


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

StackMember

El siguiente ejemplo muestra el formato del objeto StackMember.


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

Otros mandatos relevantes para proyectos IBM Cloud

Los mandatos siguientes no forman parte del plugin de CLI de proyectos, pero puede utilizarlos para completar tareas relacionadas con proyectos como, por ejemplo, adjuntar etiquetas a un proyecto. Esta lista no es exhaustiva de todos los mandatos relevantes que están disponibles para utilizar con proyectos. En su lugar, esta lista es un punto de partida para explorar otros mandatos que puede utilizar con proyectos.

Algunos de los mandatos siguientes pueden requerir la instalación de sus plug-ins específicos para poder ejecutarlos.

Ejecute ibmcloud resource tag-attach para adjuntar etiquetas a un proyecto:

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

Ejecute ibmcloud resource search para recuperar todos los recursos de una cuenta creada por configuraciones en un proyecto:

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

Ejecute ibmcloud schematics logs para recuperar los archivos de registro para un espacio de trabajo de Schematics:

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