Referência da CLI do Projeto.

A interface de linha de comando IBM Cloud® ( IBM Cloud CLI) fornece recursos adicionais para ofertas de serviços. Você pode usar a CLI do IBM Cloud para gerenciar os projetos aos quais tem acesso.

Antes de Iniciar

Instale a CLI da IBM Cloud.
Instale o Project CLI executando o seguinte comando:

ibmcloud plugin install project

Você será notificado na linha de comandos quando as atualizações da CLI e dos plug-ins da IBM Cloud estiverem disponíveis. Certifique-se de manter a sua CLI atualizada para que seja possível usar os comandos mais recentes. É possível visualizar a versão atual de todos os plug-ins instalados executando ibmcloud plugin list.

Projetos

Comandos para recurso Projetos.

`ibmcloud project select`

Alias: target

Selecione um projeto como o contexto atual.

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

Exemplos

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

Como alternativa, você pode selecionar por nome de projeto

ibmcloud project select ProjectA

Para cancelar a seleção de um projeto

ibmcloud project select --unset-project

Opções de comando

--unset-project (bool): Projeto de destino não definido
--output (string): Escolha um formato de saída - pode ser "json" ou "table". (padrão 'table')
-q, --quiet (bool): Suprime mensagens detalhadas.

ibmcloud project select --unset-project

`ibmcloud project create`

Crie um projeto e configure de forma assíncrona as ferramentas para gerenciá-lo. Inclua uma arquitetura implementável, customizando a configuração Depois que as alterações forem validadas e aprovadas, implemente os recursos que o projeto configura. Para obter mais informações, consulte Criando um projeto

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]

Opções de comando

--definition (ProjectPrototypeDefinition)

A definição do projeto. Esta opção JSON pode, em vez disso, ser fornecida configurando campos individuais com outras opções. É mutuamente exclusivo com essas opções.

Forneça uma opção de cadeia de caracteres JSON ou especifique um arquivo JSON para leitura, fornecendo uma opção de caminho de arquivo que comece com @, por exemplo, --definition=@path/to/file.json.

--location (string)

O local do IBM Cloud no qual um recurso é implementado Obrigatório.

Os valores permitidos são: us-south, us-east, eu-gb, eu-de, ca-tor.

--resource-group (string)

O nome do grupo de recursos onde os dados e ferramentas do projeto são criados. Obrigatório.

O comprimento máximo é de 64 caracteres. O comprimento mínimo é de 0 caracteres. O valor deve corresponder à expressão regular /^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/.

--configs (ProjectConfigPrototype[])

As configurações do projeto Essas configurações são incluídas na resposta de criação de um projeto somente se uma matriz de configuração for especificada na carga útil da solicitação

O valor padrão é []. O tamanho máximo é 100 itens. O tamanho mínimo é 0 itens.

Forneça uma opção de cadeia de caracteres JSON ou especifique um arquivo JSON para leitura, fornecendo uma opção de caminho de arquivo que comece com @, por exemplo, --configs=@path/to/file.json.

--environments (EnvironmentPrototype[])

O ambiente do projeto Esses ambientes são incluídos na resposta da criação de um projeto somente se uma matriz de ambientes for especificada na carga útil da solicitação

O valor padrão é []. O tamanho máximo é 20 itens. O tamanho mínimo é 0 itens.

Forneça uma opção de cadeia de caracteres JSON ou especifique um arquivo JSON para leitura, fornecendo uma opção de caminho de arquivo que comece com @, por exemplo, --environments=@path/to/file.json.

--definition-name (string)

O nome do projeto. Ele é exclusivo dentro da conta entre regiões. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 128 caracteres. O comprimento mínimo é de 1 caracteres. O valor deve corresponder à expressão regular /^(?!\\s)(?!.*\\s$)[^'"`\/<>{}\\x00-\\x1F]+$/.

--definition-description (string)

Uma breve explicação do uso do projeto na configuração de uma arquitetura implementável. Um projeto pode ser criado sem fornecer uma descrição. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O valor-padrão é . O comprimento máximo é de 1024 caracteres. O comprimento mínimo é de 0 caracteres. O valor deve corresponder à expressão regular /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.

--definition-auto-deploy-mode (string)

Essa é uma configuração avançada da implantação automática para informar como a implantação automática deve se comportar quando estiver ativada. Há duas opções:

auto_approval aprovará automaticamente a configuração depois de validada sem a confirmação do usuário.

manual_approval exigirá a confirmação do usuário para aprovar a configuração depois de validada, antes de iniciar a implementação da configuração. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O valor padrão é manual_approval. Os valores permitidos são: auto_approval, manual_approval.

--definition-monitoring-enabled (bool)

Um sinalizador booleano para ativar a detecção de desvio automático Use esse campo para executar uma verificação diária para comparar as configurações com os recursos implementados e detectar qualquer diferença. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O valor padrão é false.

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

A política que indica se os recursos não foram implementados ou não quando um projeto foi excluído. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O valor padrão é true.

--definition-store (ProjectDefinitionStore)

Os detalhes necessários para personalizar as configurações do projeto de armazenamento. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

--definition-terraform-engine (ProjectTerraformEngineSettings)

Esquema experimental - para fins de prototipagem. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

--definition-auto-deploy (bool)

Um sinalizador booleano para ativar a implementação automática de configurações. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O valor padrão é false.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplos

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

Como alternativa, as opções granulares estão disponíveis para os subcampos de opções de sequência 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`

Liste os projetos existentes Os projetos são classificados por ID. Observação: se a opção --all-pages não for definida, o comando recuperará apenas uma única página da coleção.

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

Opções de comando

--token (string)

O servidor usa esse parâmetro para determinar a primeira entrada retornada na próxima página. Se esse parâmetro não for especificado, a primeira página lógica será retornada

O valor-padrão é . O comprimento máximo é de 1536 caracteres. O comprimento mínimo é de 0 caracteres. O valor deve corresponder à expressão regular /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.

--limit (int64)

O número máximo de recursos a serem retornados. O número de recursos que são retornados é o mesmo, exceto para a última página.

O valor padrão é 10. O valor máximo é 100. O valor mínimo é 1.

--all-pages (bool)

Invoca várias solicitações para exibir todas as páginas da coleção para a lista.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplo

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

Exemplo de saída

Uma solicitação de exemplo para listar projetos..

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

Caminho padrão do JMESP

Uma consulta JMESPath será aplicada a essa saída desse comando por padrão, se não for fornecida pelo usuário. A consulta exata dependerá do cenário e do formato de saída solicitado. Você pode ver a condição para cada consulta JMESPath padrão na tabela a seguir:

Caminho padrão do JMESP
Resposta	Saída	Consultar
Sucesso	Padrão
	Tabela	`projects[].{id: id, name: definition.name, state: state}`
Erro	Padrão
	Tabela	`projects[].{id: id, name: definition.name, state: state}`
Todas as páginas	Padrão
	Tabela	`projects[].{id: id, name: definition.name, state: state}`

Se uma consulta JMESPath personalizada for fornecida, ela substituirá qualquer um dos JMESPath da tabela acima.

`ibmcloud project get`

Obter informações sobre um projeto.

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

Opções de comando

--id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

Exemplo

ibmcloud project get \
    --id exampleString

Exemplo de saída

Uma resposta de amostra para recuperar um projeto com configurações.

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

Caminho padrão do JMESP

Caminho padrão do JMESP
Resposta	Saída	Consultar
Sucesso	Padrão
	Tabela	`{id: id, name: definition.name, state: state}`
Erro	Padrão
	Tabela	`{id: id, name: definition.name, state: state}`
Todas as páginas	Padrão
	Tabela	`{id: id, name: definition.name, state: state}`

Se uma consulta JMESPath personalizada for fornecida, ela substituirá qualquer um dos JMESPath da tabela acima.

`ibmcloud project update`

Atualize um projeto especificando seu 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]

Opções de comando

--id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--definition (ProjectDefinitionPatch)

A definição do projeto. Esta opção JSON pode, em vez disso, ser fornecida configurando campos individuais com outras opções. É mutuamente exclusivo com essas opções.

--definition-name (string)

O nome do projeto. Ele é exclusivo dentro da conta entre regiões. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 128 caracteres. O comprimento mínimo é de 1 caracteres. O valor deve corresponder à expressão regular /^(?!\\s)(?!.*\\s$)[^'"`\/<>{}\\x00-\\x1F]+$/.

--definition-description (string)

O comprimento máximo é de 1024 caracteres. O comprimento mínimo é de 0 caracteres. O valor deve corresponder à expressão regular /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.

--definition-auto-deploy-mode (string)

Essa é uma configuração avançada da implantação automática para informar como a implantação automática deve se comportar quando estiver ativada. Há duas opções:

auto_approval aprovará automaticamente a configuração depois de validada sem a confirmação do usuário.

manual_approval exigirá a confirmação do usuário para aprovar a configuração depois de validada, antes de iniciar a implementação da configuração. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

Os valores permitidos são: auto_approval, manual_approval.

--definition-monitoring-enabled (bool)

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

--definition-store (ProjectDefinitionStore)

--definition-terraform-engine (ProjectTerraformEngineSettings)

Esquema experimental - para fins de prototipagem. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

--definition-auto-deploy (bool)

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplos

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

Como alternativa, as opções granulares estão disponíveis para os subcampos de opções de sequência 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

Exemplo de saída

Uma resposta de amostra para recuperar um projeto com configurações.

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

Exclua um documento de projeto especificando o ID. Um projeto pode ser excluído somente após a exclusão de todos os seus recursos.

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

Opções de comando

--id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

Exemplo

ibmcloud project delete \
    --id exampleString

Exemplo de saída

A resposta de exemplo para uma solicitação de exclusão de um projeto

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

Ambientes

Recurso de Comandos para Ambientes

`ibmcloud project environment-create`

Crie um ambiente para agrupar configurações relacionadas e compartilhar valores entre elas para facilitar a implementação. Para obter mais informações, consulte Criando um ambiente

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]

Opções de comando

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--definition (EnvironmentDefinitionRequiredProperties)

A definição de ambiente Esta opção JSON pode, em vez disso, ser fornecida configurando campos individuais com outras opções. É mutuamente exclusivo com essas opções.

--definition-description (string)

A descrição do ambiente. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

--definition-name (string)

O nome do ambiente. Ele é exclusivo dentro da conta entre projetos e regiões Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 128 caracteres. O comprimento mínimo é de 1 caracteres. O valor deve corresponder à expressão regular /^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]+$/.

--definition-authorizations (ProjectConfigAuth)

Os detalhes da autorização É possível autorizar usando um perfil confiável ou uma chave API no Secrets Manager. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

--definition-inputs (mapa genérico)

As variáveis de entrada que são usadas para definição de configuração e ambiente. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

--definition-compliance-profile (ProjectComplianceProfile)

O perfil necessário para conformidade. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplos

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

Como alternativa, as opções granulares estão disponíveis para os subcampos de opções de sequência 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

Exemplo de saída

A resposta do ambiente de amostra

{
  "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 os ambientes disponíveis Para obter mais informações, consulte Criando um ambiente Observação: se a opção --all-pages não for definida, o comando recuperará apenas uma única página da coleção.

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

Opções de comando

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--token (string)

O servidor usa esse parâmetro para determinar a primeira entrada retornada na próxima página. Se esse parâmetro não for especificado, a primeira página lógica será retornada

--limit (int64)

O número máximo de recursos a serem retornados. O número de recursos que são retornados é o mesmo, exceto para a última página.

O valor padrão é 10. O valor máximo é 100. O valor mínimo é 1.

--all-pages (bool)

Invocar várias solicitações para exibir todas as páginas da coleção para ambientes.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplo

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

Exemplo de saída

A resposta do ambiente de amostra para uma 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`

Obtenha um ambiente Saiba mais.

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

Opções de comando

--id (string)

O ID do ambiente. Obrigatório.

O comprimento máximo é de 256 caracteres. O comprimento mínimo é de 1 caracteres. O valor deve corresponder à expressão regular /^(?!\\s)(?!.*\\s$).+$/.

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplo

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

Exemplo de saída

A resposta do ambiente de amostra

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

Atualizar um ambiente especificando seu ID. Saiba mais.

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]

Opções de comando

--id (string)

O ID do ambiente. Obrigatório.

O comprimento máximo é de 256 caracteres. O comprimento mínimo é de 1 caracteres. O valor deve corresponder à expressão regular /^(?!\\s)(?!.*\\s$).+$/.

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--definition (EnvironmentDefinitionPropertiesPatch)

A definição de ambiente usada para atualizações. Esta opção JSON pode, em vez disso, ser fornecida configurando campos individuais com outras opções. É mutuamente exclusivo com essas opções.

--definition-description (string)

A descrição do ambiente. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 1024 caracteres. O comprimento mínimo é de 0 caracteres. O valor deve corresponder à expressão regular /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.

--definition-name (string)

O nome do ambiente. Ele é exclusivo dentro da conta entre projetos e regiões Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 128 caracteres. O comprimento mínimo é de 1 caracteres. O valor deve corresponder à expressão regular /^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]+$/.

--definition-authorizations (ProjectConfigAuth)

--definition-inputs (mapa genérico)

--definition-compliance-profile (ProjectComplianceProfile)

O perfil necessário para conformidade. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplos

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

Como alternativa, as opções granulares estão disponíveis para os subcampos de opções de sequência 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

Exemplo de saída

A resposta do ambiente de amostra

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

Excluir um ambiente em um projeto especificando seu ID.

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

Opções de comando

--id (string)

O ID do ambiente. Obrigatório.

O comprimento máximo é de 256 caracteres. O comprimento mínimo é de 1 caracteres. O valor deve corresponder à expressão regular /^(?!\\s)(?!.*\\s$).+$/.

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplo

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

Exemplo de saída

O exemplo de resposta de exclusão de ambiente.

{
  "id" : "env123"
}

Configurações

Comandos para o recurso de configurações

`ibmcloud project config-create`

Adicionar uma nova configuração a um projeto.

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]

Opções de comando

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--definition (ProjectConfigDefinitionPrototype)

Esta opção JSON pode, em vez disso, ser fornecida configurando campos individuais com outras opções. É mutuamente exclusivo com essas opções.

--schematics (SchematicsWorkspace)

Uma área de trabalho Schematics para usar para implementar essa arquitetura implementável.

Se estiver importando dados de um espaço de trabalho existente do Schematics que não seja apoiado por um carrinho, será necessário fornecer um locator_id. Se estiver usando um espaço de trabalho Schematics que é apoiado pelo carrinho, não é necessário um locator_id porque o espaço de trabalho Schematics tem um.

Há 3 cenários:

Se apenas um locator_id for especificado, uma nova área de trabalho do Schematics será instanciado com esse locator_id

Se apenas um esquema workspace_crn for especificado, um 400 será retornado se um locator_id não for localizado na área de trabalho do esquema existente.

Se um Schematics workspace_crn e um locator_id forem especificados, um código 400 será retornado se o locator_id especificado não estiver de acordo com o locator_id no espaço de trabalho Schematics existente.

Para obter mais informações, consulte Criação de espaços de trabalho e importação do modelo do Terraform. Esta opção JSON pode, em vez disso, ser fornecida configurando campos individuais com outras opções. É mutuamente exclusivo com essas opções.

Forneça uma opção de cadeia de caracteres JSON ou especifique um arquivo JSON para leitura, fornecendo uma opção de caminho de arquivo que comece com @, por exemplo, --schematics=@path/to/file.json.

--definition-compliance-profile (ProjectComplianceProfile)

O perfil necessário para conformidade. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

--definition-locator-id (string)

Uma concatenação exclusiva do ID do catálogo e do ID da versão que identifica a arquitetura implementável no catálogo. Se estiver importando de um espaço de trabalho existente do Schematics que não tenha o suporte do carrinho, será necessário um locator_id. Se estiver usando um espaço de trabalho Schematics que é apoiado pelo carrinho, não é necessário um locator_id porque o espaço de trabalho Schematics tem um.

Há 3 cenários:

Se apenas um locator_id for especificado, uma nova área de trabalho do Schematics será instanciado com esse locator_id

Se apenas um esquema workspace_crn for especificado, um 400 será retornado se um locator_id não for localizado na área de trabalho do esquema existente.

Se um Schematics workspace_crn e um locator_id forem especificados, uma mensagem 400 será retornada se o locator_id especificado não concordar com o locator_id na área de trabalho Schematics existente. Para obter mais informações sobre a criação de um espaço de trabalho Schematics, consulte Criação de espaços de trabalho e importação do modelo do Terraform. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 512 caracteres. O comprimento mínimo é de 1 caracteres. O valor deve corresponder à expressão regular /^(?!\\s)(?!.*\\s$)[\\.0-9a-z-A-Z_-]+$/.

--definition-members (StackMember[])

As arquiteturas implementáveis de membros que estão incluídas na pilha. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O tamanho máximo é 100 itens. O tamanho mínimo é 0 itens.

--definition-uses (ProjectConfigUses[])

As arquiteturas de implementação dependentes que são referenciadas por essa configuração. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O tamanho máximo é 100 itens. O tamanho mínimo é 0 itens.

--definition-description (string)

Uma descrição da configuração do projeto Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

--definition-name (string)

O nome de configuração. Ele é exclusivo dentro da conta entre projetos e regiões Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 128 caracteres. O comprimento mínimo é de 1 caracteres. O valor deve corresponder à expressão regular /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.

--definition-authorizations (ProjectConfigAuth)

Os detalhes da autorização Ele pode autorizar usando um perfil confiável ou uma chave de API em Secrets Manager. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

--definition-inputs (mapa genérico)

--definition-settings (mapa genérico)

As variáveis de ambiente Schematics para usar para implementar a configuração. As configurações estarão disponíveis apenas se elas forem especificadas quando a configuração for criada inicialmente Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

--definition-environment-id (string)

O ID do ambiente do projeto. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--definition-resource-crns (sequência[])

Os CRNs dos recursos associados a essa configuração. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

Os itens da lista devem corresponder à expressão regular /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/. O tamanho máximo é 110 itens. O tamanho mínimo é 0 itens.

--schematics-workspace-crn (string)

Um nome do recurso IBM Cloud que identifica exclusivamente um recurso. Essa opção fornece um valor para um subcampo da opção JSON 'schematics'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 512 caracteres. O comprimento mínimo é de 4 caracteres. O valor deve corresponder à expressão regular /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplos

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

Como alternativa, as opções granulares estão disponíveis para os subcampos de opções de sequência 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`

Recupere a coleção de configurações Observação: se a opção --all-pages não for definida, o comando recuperará apenas uma única página da coleção.

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

Opções de comando

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--token (string)

O servidor usa esse parâmetro para determinar a primeira entrada retornada na próxima página. Se esse parâmetro não for especificado, a primeira página lógica será retornada

--limit (int64)

O número máximo de recursos a serem retornados. O número de recursos que são retornados é o mesmo, exceto para a última página.

O valor padrão é 10. O valor máximo é 100. O valor mínimo é 1.

--all-pages (bool)

Invoca várias solicitações para exibir todas as páginas da coleção de configurações.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplo

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

Exemplo de saída

A resposta de exemplo para uma solicitação para obter as configurações do projeto

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

Caminho padrão do JMESP

Caminho padrão do JMESP
Resposta	Saída	Consultar
Sucesso	Padrão
	Tabela	`configs[].{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`
Erro	Padrão
	Tabela	`configs[].{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`
Todas as páginas	Padrão
	Tabela	`configs[].{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`

Se uma consulta JMESPath personalizada for fornecida, ela substituirá qualquer um dos JMESPath da tabela acima.

`ibmcloud project config`

Recupere a configuração do projeto especificado em um projeto específico

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

Opções de comando

--id (string)

O ID de configuração exclusivo. Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

Exemplo

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

Caminho padrão do JMESP

Caminho padrão do JMESP
Resposta	Saída	Consultar
Sucesso	Padrão
	Tabela	`{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`
Erro	Padrão
	Tabela	`{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`
Todas as páginas	Padrão
	Tabela	`{id: id, name: definition.name, project_name: project.definition.name, state: state, state_code: state_code, version: version}`

Se uma consulta JMESPath personalizada for fornecida, ela substituirá qualquer um dos JMESPath da tabela acima.

`ibmcloud project config-update`

Atualize uma configuração em um projeto, especificando o ID. Saiba mais.

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]

Opções de comando

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--id (string)

O ID de configuração exclusivo. Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--definition (ProjectConfigDefinitionPatch)

Esta opção JSON pode, em vez disso, ser fornecida configurando campos individuais com outras opções. É mutuamente exclusivo com essas opções.

--definition-compliance-profile (ProjectComplianceProfile)

O perfil necessário para conformidade. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

--definition-locator-id (string)

Há 3 cenários:

Se apenas um locator_id for especificado, uma nova área de trabalho do Schematics será instanciado com esse locator_id

Se apenas um esquema workspace_crn for especificado, um 400 será retornado se um locator_id não for localizado na área de trabalho do esquema existente.

Se um Schematics workspace_crn e um locator_id forem especificados, uma mensagem 400 será retornada se o locator_id especificado não concordar com o locator_id na área de trabalho Schematics existente. Para obter mais informações sobre a criação de um espaço de trabalho Schematics, consulte Criação de espaços de trabalho e importação do modelo do Terraform. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 512 caracteres. O comprimento mínimo é de 1 caracteres. O valor deve corresponder à expressão regular /^(?!\\s)(?!.*\\s$)[\\.0-9a-z-A-Z_-]+$/.

--definition-members (StackMember[])

As arquiteturas implementáveis de membros que estão incluídas na pilha. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O tamanho máximo é 100 itens. O tamanho mínimo é 0 itens.

--definition-uses (ProjectConfigUses[])

O tamanho máximo é 100 itens. O tamanho mínimo é 0 itens.

--definition-description (string)

Uma descrição da configuração do projeto Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 1024 caracteres. O comprimento mínimo é de 0 caracteres. O valor deve corresponder à expressão regular /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.

--definition-name (string)

O comprimento máximo é de 128 caracteres. O comprimento mínimo é de 1 caracteres. O valor deve corresponder à expressão regular /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.

--definition-authorizations (ProjectConfigAuth)

--definition-inputs (mapa genérico)

--definition-settings (mapa genérico)

--definition-environment-id (string)

O ID do ambiente do projeto. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--definition-resource-crns (sequência[])

Os CRNs dos recursos associados a essa configuração. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

Os itens da lista devem corresponder à expressão regular /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/. O tamanho máximo é 110 itens. O tamanho mínimo é 0 itens.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplos

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

Como alternativa, as opções granulares estão disponíveis para os subcampos de opções de sequência 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`

Exclua uma configuração em um projeto especificando seu ID.

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

Opções de comando

--id (string)

O ID de configuração exclusivo. Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

Exemplo

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

Exemplo de saída

A resposta de exemplo para uma solicitação para excluir uma configuração..

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

`ibmcloud project config-force-approve`

Forçar a aprovação de edições de configuração para a configuração principal com um comentário de aprovação

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

Opções de comando

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--id (string)

O ID de configuração exclusivo. Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--comment (string)

Notas sobre a ação de rascunho do projeto Se essa ação for uma aprovação forçada no rascunho da configuração, ela deverá incluir um comentário não vazio. Obrigatório.

O comprimento máximo é de 1024 caracteres. O comprimento mínimo é de 1 caracteres. O valor deve corresponder à expressão regular /^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]+$/.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplo

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

Exemplo de saída

A resposta de exemplo para uma solicitação para um rascunho de configuração de arquitetura implementável

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

Aprovar e mesclar edições de configuração na configuração principal.

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

Opções de comando

--id (string)

O ID de configuração exclusivo. Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--comment (string)

Notas sobre a ação de rascunho do projeto Se essa ação for uma aprovação forçada no rascunho da configuração, ela deverá incluir um comentário não vazio.

O comprimento máximo é de 1024 caracteres. O comprimento mínimo é de 1 caracteres. O valor deve corresponder à expressão regular /^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]+$/.

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplo

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

Exemplo de saída

A resposta de exemplo para uma solicitação para um rascunho de configuração de arquitetura implementável

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

Execute uma verificação de validação em uma configuração específica no projeto A verificação inclui criar ou atualizar a área de trabalho Schematics associada com uma tarefa de plano, executar as varreduras de CRA e estimativa de custo.

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

Opções de comando

--id (string)

O ID de configuração exclusivo. Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplo

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

Exemplo de saída

A resposta de exemplo para uma solicitação para um rascunho de configuração de arquitetura implementável

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

Executa uma verificação de validação de uma configuração passada por meio da API. A verificação inclui a criação de um espaço de trabalho Schematics com um trabalho de planejamento, a execução das varreduras de CRA e a estimativa de custos.

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]

Opções de comando

--id (string)

O ID de configuração exclusivo. Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--definition (ProjectConfigDefinitionPrototype)

Esta opção JSON pode, em vez disso, ser fornecida configurando campos individuais com outras opções. É mutuamente exclusivo com essas opções.

--schematics (SchematicsWorkspace)

Uma área de trabalho Schematics para usar para implementar essa arquitetura implementável.

Se estiver importando dados de um espaço de trabalho existente do Schematics que não seja apoiado por um carrinho, será necessário fornecer um locator_id. Se estiver usando um espaço de trabalho Schematics que é apoiado pelo carrinho, não é necessário um locator_id porque o espaço de trabalho Schematics tem um.

Há 3 cenários:

Se apenas um locator_id for especificado, uma nova área de trabalho do Schematics será instanciado com esse locator_id

Se apenas um esquema workspace_crn for especificado, um 400 será retornado se um locator_id não for localizado na área de trabalho do esquema existente.

Se um Schematics workspace_crn e um locator_id forem especificados, um código 400 será retornado se o locator_id especificado não estiver de acordo com o locator_id no espaço de trabalho Schematics existente.

--definition-compliance-profile (ProjectComplianceProfile)

O perfil necessário para conformidade. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

--definition-locator-id (string)

Há 3 cenários:

Se apenas um locator_id for especificado, uma nova área de trabalho do Schematics será instanciado com esse locator_id

Se apenas um esquema workspace_crn for especificado, um 400 será retornado se um locator_id não for localizado na área de trabalho do esquema existente.

Se um Schematics workspace_crn e um locator_id forem especificados, uma mensagem 400 será retornada se o locator_id especificado não concordar com o locator_id na área de trabalho Schematics existente. Para obter mais informações sobre a criação de um espaço de trabalho Schematics, consulte Criação de espaços de trabalho e importação do modelo do Terraform. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 512 caracteres. O comprimento mínimo é de 1 caracteres. O valor deve corresponder à expressão regular /^(?!\\s)(?!.*\\s$)[\\.0-9a-z-A-Z_-]+$/.

--definition-members (StackMember[])

As arquiteturas implementáveis de membros que estão incluídas na pilha. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O tamanho máximo é 100 itens. O tamanho mínimo é 0 itens.

--definition-uses (ProjectConfigUses[])

O tamanho máximo é 100 itens. O tamanho mínimo é 0 itens.

--definition-description (string)

Uma descrição da configuração do projeto Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

--definition-name (string)

O comprimento máximo é de 128 caracteres. O comprimento mínimo é de 1 caracteres. O valor deve corresponder à expressão regular /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.

--definition-authorizations (ProjectConfigAuth)

--definition-inputs (mapa genérico)

--definition-settings (mapa genérico)

--definition-environment-id (string)

O ID do ambiente do projeto. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--definition-resource-crns (sequência[])

Os CRNs dos recursos associados a essa configuração. Essa opção fornece um valor para um subcampo da opção JSON 'definition'. É mutuamente exclusivo com essa opção.

Os itens da lista devem corresponder à expressão regular /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/. O tamanho máximo é 110 itens. O tamanho mínimo é 0 itens.

--schematics-workspace-crn (string)

Um nome do recurso IBM Cloud que identifica exclusivamente um recurso. Essa opção fornece um valor para um subcampo da opção JSON 'schematics'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 512 caracteres. O comprimento mínimo é de 4 caracteres. O valor deve corresponder à expressão regular /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplos

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

Como alternativa, as opções granulares estão disponíveis para os subcampos de opções de sequência 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::

Exemplo de saída

O objeto de resultado para prevalecer.

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

`ibmcloud project get-prevalidate`

Recuperar os resultados da prevalência usando uma chave.

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

Opções de comando

--id (string)

O ID de configuração exclusivo. Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--result-id (string)

O identificador exclusivo para obter eventos de prevalência. Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplo

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

Exemplo de saída

Um exemplo de resposta para obter resultados de prevalência.

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

Implementar a configuração de um projeto. Essa operação é assíncrona e pode ser rastreada usando a API de configuração do projeto get com metadados completos.

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

Opções de comando

--id (string)

O ID de configuração exclusivo. Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplo

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

Exemplo de saída

A resposta de exemplo para uma solicitação para um rascunho de configuração de arquitetura implementável

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

Remova a implementação dos recursos de configuração de um projeto A operação remove a implementação de todos os recursos implementados com a configuração específica. Os recursos de configuração podem ser rastreados usando a API de configuração do projeto get com metadados completos.

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

Opções de comando

--id (string)

O ID de configuração exclusivo. Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplo

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

Exemplo de saída

A resposta de exemplo para uma solicitação para um rascunho de configuração de arquitetura implementável

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

Sincronize uma configuração do projeto analisando as execuções de pipeline associadas e logs da área de trabalho Schematics para obter a configuração de volta para um estado de funcionamento.

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

Opções de comando

--id (string)

O ID de configuração exclusivo. Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--schematics (SchematicsWorkspace)

Uma área de trabalho Schematics para usar para implementar essa arquitetura implementável.

Se estiver importando dados de um espaço de trabalho existente do Schematics que não seja apoiado por um carrinho, será necessário fornecer um locator_id. Se estiver usando um espaço de trabalho Schematics que é apoiado pelo carrinho, não é necessário um locator_id porque o espaço de trabalho Schematics tem um.

Há 3 cenários:

Se apenas um locator_id for especificado, uma nova área de trabalho do Schematics será instanciado com esse locator_id

Se apenas um esquema workspace_crn for especificado, um 400 será retornado se um locator_id não for localizado na área de trabalho do esquema existente.

Se um Schematics workspace_crn e um locator_id forem especificados, um código 400 será retornado se o locator_id especificado não estiver de acordo com o locator_id no espaço de trabalho Schematics existente.

--schematics-workspace-crn (string)

Um nome do recurso IBM Cloud que identifica exclusivamente um recurso. Essa opção fornece um valor para um subcampo da opção JSON 'schematics'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 512 caracteres. O comprimento mínimo é de 4 caracteres. O valor deve corresponder à expressão regular /^(?!\\s)(?!.*\\s$)(crn)[^'"`<>{}\\s\\x00-\\x1F]*$/.

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplos

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

Como alternativa, as opções granulares estão disponíveis para os subcampos de opções de sequência 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`

Listar os recursos que são implementados por uma configuração

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

Opções de comando

--id (string)

O ID de configuração exclusivo. Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplo

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

Exemplo de saída

A resposta de exemplo para uma solicitação para obter os recursos de configuração do projeto

{
  "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 entradas no nível de pilha que os usuários precisam configurar juntamente com os valores de entrada no nível de membro Esses valores são incluídos na entrada do catálogo quando a pilha de arquitetura implementável é exportada para um catálogo privado e são necessários para a implementação da pilha de arquitetura implementável. Uma referência pode ser adicionada a um valor ou adicionar o valor explicitamente no nível do membro.

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]

Opções de comando

--id (string)

O ID de configuração exclusivo. Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--stack-definition (StackDefinitionBlockPrototype)

O bloco de definição para uma definição de pilha Esta opção JSON pode, em vez disso, ser fornecida configurando campos individuais com outras opções. É mutuamente exclusivo com essas opções.

Forneça uma opção de cadeia de caracteres JSON ou especifique um arquivo JSON para leitura, fornecendo uma opção de caminho de arquivo que comece com @, por exemplo, --stack-definition=@path/to/file.json.

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

Define as entradas que os usuários precisam configurar no nível de pilha Essas entradas são incluídas no catálogo quando a pilha de arquitetura implementável é exportada para um catálogo privado. Essa opção fornece um valor para um sub-campo da opção JSON 'stack-definition'. É mutuamente exclusivo com essa opção.

O tamanho máximo é 300 itens. O tamanho mínimo é 0 itens.

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

As saídas associadas a esta definição de pilha Essa opção fornece um valor para um sub-campo da opção JSON 'stack-definition'. É mutuamente exclusivo com essa opção.

O tamanho máximo é 100 itens. O tamanho mínimo é 0 itens.

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplos

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

Como alternativa, as opções granulares estão disponíveis para os subcampos de opções de sequência JSON:

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

Exemplo de saída

Resposta de amostra de uma operação de criação de modelo de pilha.

{
  "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 a definição de pilha associada à configuração.

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

Opções de comando

--id (string)

O ID de configuração exclusivo. Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplo

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

Exemplo de saída

Resposta de amostra de uma operação de criação de modelo de pilha.

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

Atualize a definição de pilha associada à configuração.

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]

Opções de comando

--id (string)

O ID de configuração exclusivo. Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--stack-definition (StackDefinitionBlockPrototype)

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

O tamanho máximo é 300 itens. O tamanho mínimo é 0 itens.

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

As saídas associadas a esta definição de pilha Essa opção fornece um valor para um sub-campo da opção JSON 'stack-definition'. É mutuamente exclusivo com essa opção.

O tamanho máximo é 100 itens. O tamanho mínimo é 0 itens.

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplos

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

Como alternativa, as opções granulares estão disponíveis para os subcampos de opções de sequência JSON:

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

Exemplo de saída

Resposta de amostra de uma operação de modelo de pilha de correções.

{
  "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 a pilha de arquiteturas implementáveis para um catálogo privado Todas as arquiteturas implementáveis membros dentro da pilha devem ser validadas e implementadas antes da pilha ser exportada. A definição de pilha também deve existir antes que a pilha seja exportada A pilha pode ser exportada como um novo produto ou como uma nova versão de um produto 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]

Opções de comando

--id (string)

O ID de configuração exclusivo. Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--settings (StackDefinitionExportRequest)

A carga útil para a solicitação de exportação de catálogos privados Esta opção JSON pode, em vez disso, ser fornecida configurando campos individuais com outras opções. É mutuamente exclusivo com essas opções.

Forneça uma opção de cadeia de caracteres JSON ou especifique um arquivo JSON para leitura, fornecendo uma opção de caminho de arquivo que comece com @, por exemplo, --settings=@path/to/file.json.

--settings-catalog-id (string)

O ID do catálogo a ser publicado Essa opção fornece um valor para um subcampo da opção JSON 'settings'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 36 caracteres. O valor deve corresponder à expressão regular /^[\\-0-9a-zA-Z]+$/.

--settings-target-version (string)

O valor do semver dessa nova versão do produto. Essa opção fornece um valor para um subcampo da opção JSON 'settings'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 60 caracteres. O comprimento mínimo é de 5 caracteres. O valor deve corresponder à expressão 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 (string)

A variação do software atual que está sendo integrado. Válido somente se o tipo de produto for módulo ou solução. Consulte flavor na oferta de importação do Catalog. Essa opção fornece um valor para um subcampo da opção JSON 'settings'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.

--settings-label (string)

O rótulo do produto Essa opção fornece um valor para um subcampo da opção JSON 'settings'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.

--settings-tags (sequência[])

Identificações associadas ao produto de catálogo Essa opção fornece um valor para um subcampo da opção JSON 'settings'. É mutuamente exclusivo com essa opção.

O valor padrão é []. Os itens da lista devem corresponder à expressão regular /^[a-zA-Z0-9][a-zA-Z0-9-_]*$/. O tamanho máximo é 10 itens. O tamanho mínimo é 0 itens.

--settings-product-id (string)

O ID do produto a ser publicado Essa opção fornece um valor para um subcampo da opção JSON 'settings'. É mutuamente exclusivo com essa opção.

O comprimento máximo é de 36 caracteres. O valor deve corresponder à expressão regular /^[\\-0-9a-zA-Z]+$/.

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--output (string)

Escolha um formato de saída - pode ser 'json', 'yaml', 'tui' ou 'table'. (padrão 'table')

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplos

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

Como alternativa, as opções granulares estão disponíveis para os subcampos de opções de sequência 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 '[]'

Exemplo de saída

Resposta de amostra da exportação de uma definição de pilha para o 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`

Recupera uma lista de versões anteriores e atuais de uma configuração de projeto em um projeto específico

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

Opções de comando

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--id (string)

O ID de configuração exclusivo. Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplo

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

Exemplo de saída

A resposta de exemplo para uma solicitação para listar rascunhos de configuração do projeto

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

Caminho padrão do JMESP

Caminho padrão do JMESP
Resposta	Saída	Consultar
Sucesso	Padrão
	Tabela	`versions`
Erro	Padrão
	Tabela	`versions`
Todas as páginas	Padrão
	Tabela	`versions`

Se uma consulta JMESPath personalizada for fornecida, ela substituirá qualquer um dos JMESPath da tabela acima.

`ibmcloud project config-version`

Recupere uma versão específica de uma configuração em um projeto

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

Opções de comando

--project-id (string)

O ID do projeto exclusivo Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--id (string)

O ID de configuração exclusivo. Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--version (int64)

A versão de configuração Obrigatório.

O valor máximo é 10000. O valor mínimo é 0.

-q, --quiet (bool)

Suprime mensagens detalhadas.

Exemplo

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

V2 Configurações

Comandos para o recurso V2Configurations.

`ibmcloud project config-version-delete`

Exclua uma versão de configuração especificando o ID do projeto.

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

Opções de comando

--project-id (string)

O ID do projeto exclusivo Obrigatório se o projeto não estiver selecionado.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--id (string)

O ID de configuração exclusivo. Obrigatório.

O comprimento máximo é de 128 caracteres. O valor deve corresponder à expressão regular /^[\\.\\-0-9a-zA-Z]+$/.

--version (int64)

A versão de configuração Obrigatório.

O valor máximo é 10000. O valor mínimo é 0.

Exemplo

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

Exemplo de saída

A resposta de exemplo para uma solicitação para excluir uma configuração..

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

Exemplos de esquema

Os exemplos de esquema a seguir representam os dados que precisam ser especificados para uma opção de comando. Esses exemplos modelam a estrutura de dados e incluem valores de item temporário para o tipo de valor esperado. Ao executar um comando, substitua esses valores pelos valores que se aplicam ao seu ambiente, conforme apropriado.

EnvironmentDefinitionPropertiesPatch

O exemplo a seguir mostra o formato do 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

O exemplo a seguir mostra o formato do 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[]

O exemplo a seguir mostra o formato do objeto EnvironmentPrototype[] .


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

ProjectComplianceProfile

O exemplo a seguir mostra o formato do 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

O exemplo a seguir mostra o formato do objeto ProjectConfigAuth.


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

ProjectConfigDefinitionPatch

O exemplo a seguir mostra o formato do 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

O exemplo a seguir mostra o formato do 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[]

O exemplo a seguir mostra o formato do 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

O exemplo a seguir mostra o formato do 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

O exemplo a seguir mostra o formato do objeto ProjectDefinitionStore.


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

ProjectPrototypeDefinition

O exemplo a seguir mostra o formato do 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

O exemplo a seguir mostra o formato do objeto ProjectTerraformEngineSettings.


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

SchematicsWorkspace

O exemplo a seguir mostra o formato do objeto SchematicsWorkspace.


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

StackDefinitionBlockPrototype

O exemplo a seguir mostra o formato do 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

O exemplo a seguir mostra o formato do objeto StackDefinitionExportRequest.


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

StackDefinitionInputVariable

O exemplo a seguir mostra o formato do objeto StackDefinitionInputVariable.


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

StackDefinitionOutputVariable

O exemplo a seguir mostra o formato do objeto StackDefinitionOutputVariable.


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

StackMember

O exemplo a seguir mostra o formato do objeto StackMember.


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

Outros comandos relevantes para projetos do IBM Cloud

Os comandos a seguir não fazem parte do plug-in da CLI de projetos, mas é possível usá-los para concluir tarefas relacionadas ao projeto, como anexar tags a um projeto: Esta lista não é exaustiva de todos os comandos relevantes que estão disponíveis para usar com projetos Em vez disso, essa lista é um ponto de início para você explorar outros comandos que podem ser usados com projetos

Alguns dos comandos a seguir podem requerer a instalação de seus plug-ins específicos antes que seja possível executá-los:

Execute ibmcloud resource tag-attach para anexar tags a um projeto:

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

Executar ibmcloud resource search para recuperar todos os recursos em uma conta criada por configurações em um projeto:

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

Execute ibmcloud schematics logs para recuperar os arquivos de log para uma área de trabalho Schematics:

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