Como gerenciar propriedades da CLI gcloud

As propriedades são configurações que regem o comportamento da CLI gcloud.

É possível usar propriedades para definir uma configuração por produto ou por serviço, como a conta usada pela CLI gcloud para autorização, a região padrão a ser usada ao trabalhar com recursos do Compute Engine ou a opção de desativar as verificações automáticas de atualização da API CLI do gcloud. Também é possível usar as propriedades para definir as preferências da CLI gcloud, como o nível de verbosidade, e a configuração do prompt para comandos da CLI gcloud.

Propriedades e sinalizações

A CLI gcloud é compatível com algumas sinalizações globais e sinalizações de comando que têm o mesmo efeito que as propriedades da CLI gcloud. Por exemplo, a CLI da gcloud é compatível com a sinalização --project e a propriedade project. As propriedades permitem que você mantenha as mesmas configurações em várias execuções de comandos, enquanto as sinalizações afetam o comportamento do comando por invocação. As sinalizações substituem as propriedades quando as duas estão definidas.

Configurações

Uma configuração é um conjunto nomeado de propriedades da CLI gcloud. A CLI gcloud usa uma configuração chamada default como a configuração ativa inicial. A configuração default é adequada para a maioria dos casos de uso. No entanto, você também pode criar mais configurações e alterná-las conforme necessário.

Como listar propriedades

Para listar as propriedades na configuração ativa, execute gcloud config list:

gcloud config list

A CLI da gcloud retorna a lista de propriedades:

[compute]
region = us-east1
zone = us-east1-d
[core]
account = user@google.com
disable_usage_reporting = False
project = example-project
[metrics]
command_name = gcloud.config.list

Como configurar propriedades

Para definir uma propriedade na configuração ativa, execute gcloud config set. O exemplo a seguir define a propriedade project, em que PROJECT_ID é o ID exclusivo do seu projeto.

gcloud config set project PROJECT_ID

Para definir propriedades que não estejam na seção core, é preciso especificar a seção seguida por uma barra antes do nome da propriedade. O exemplo a seguir define o nome da zona como us-east1-b.

gcloud config set compute/zone us-east1-b

Como definir propriedades usando variáveis de ambiente

Também é possível definir propriedades por meio de variáveis de ambiente. Cada propriedade tem uma variável de ambiente correspondente que pode ser usada para configurá-la. O nome da variável de ambiente segue o padrão CLOUDSDK_SECTION_NAME_PROPERTY_NAME. Por exemplo, é possível definir as propriedades core/project e compute/zone da seguinte maneira:

CLOUDSDK_CORE_PROJECT=PROJECT_NAME

CLOUDSDK_COMPUTE_ZONE=ZONE_NAME

Cancelar a definição de propriedades

Para remover a configuração de uma propriedade na configuração ativa, use gcloud config unset:

gcloud config unset disable_usage_reporting

Propriedades disponíveis

A lista de todas as propriedades pode ser encontrada executando gcloud topic configurations ou gcloud config set --help e procurando a seção "Propriedades disponíveis".

A seguir