Criar uma organização.
Visualização pública: o subcomando atlas api, gerado automaticamente a partir da API de administração do MongoDB Atlas , oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça feedback em https://feedback.mongodb.com/ fóruns/930808-atlas-cli). Os recursos da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do endpoint da API fornecido.
Ao autenticar usando chaves de API, a organização à qual as chaves de API pertencem deve ter o faturamento entre organizações habilitado. A organização resultante será vinculada à organização pagadora.
Sintaxe
atlas organizations create <name> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
name | string | true | Etiqueta que identifica a organização. |
Opções
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
--apiKeyDescription | string | false | Descrição da chave API. Necessário ao criar organizações autenticadas com chaves API. |
--apiKeyRole | strings | false | Função ou funções que você deseja atribuir à chave de API. Para atribuir mais de uma função, especifique cada função com um sinalizador de função separado ou especifique todas as funções como uma lista separada por vírgula usando um sinalizador de função. Para obter a lista completa de valores aceitos, consulte o Enum de itens para o ponto de extremidade da API do Atlas correspondente: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic -API-Keys/operation/createApiKey. Para saber mais sobre as funções de usuário no nível da organização , consulte: https://dochub.mongodb.org/core/atlas-org-roles. Necessário ao criar organizações autenticadas com chaves API. |
--federationSettingsId | string | false | string exclusiva de 24dígitos hexadecimais que identifica as configurações de federação. |
-h, --help | false | ajuda para criar | |
-o, --output | string | false | Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON. |
--ownerId | string | false | String exclusiva de 24 dígitos que identifica o Atlas user para obter a função "Proprietário da organização" na organização especificada. Obrigatório se estiver usando chaves de API. |
Opções herdadas
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
-P, --profile | string | false | Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Exemplos
# Create an Atlas organization with the name myOrg: atlas organizations create myOrg --output json