--- title: Azure RM - Ad User slug: homologacao-atmosphere/azure-rm-ad-user description: Learn how to create, delete, and update users in Azure Active Directory with this comprehensive document. Discover the parameters and attributes involved, including the "account_enabled" parameter for managing user accounts. Explore various authentication docTags: createdAt: 2021-06-30T11:09:41.000Z --- ## Resumo - Crie, exclua e atualize um usuário do Azure Active Directory. ## Parâmetros | **Parâmetro** | **Tipo** | **Escolhas \| Valor Padrão** | **Comentários** | | ---------------------- | -------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | account\_enabled | boolean | Escolhas:
- false
- true | Um booleano que determina se a conta do usuário está habilitada ou não.

Usado ao criar ou atualizar uma conta de usuário. | | ad\_user | string | | Nome de usuário do Active Directory. Use ao autenticar com um usuário do Active Directory em vez do principal de serviço. | | adfs\_authority\_url | string | | URL de autoridade do Azure AD. Use ao autenticar com nome de usuário / senha e tenha sua própria autoridade ADFS. | | api\_profile | string | Default:
"latest" | Seleciona um perfil de API para usar ao se comunicar com os serviços do Azure. O valor padrão de latesté apropriado para nuvens públicas; os valores futuros permitirão o uso com a pilha do Azure. | | attribute\_name | string | | O nome de um atributo que você deseja corresponder a attribute\_value.

Se attribute\_name não for um tipo de coleção, ele atualizará ou excluirá o usuário onde attribute\_name é igual a attribute\_value.

Se attribute\_name for um tipo de coleção, ele atualizará ou excluirá o usuário em que attribute\_value está em attribute\_name.

Mutuamente exclusivo com *object\_id* , *user\_principal\_name* e *odata\_filter* .

Obrigatório junto com *attribute\_value* . | | attribute\_value | string | | O valor para corresponder ao attribute\_name.

Se attribute\_name não for um tipo de coleção, ele atualizará ou excluirá o usuário onde attribute\_name é igual a attribute\_value.

Se attribute\_name for um tipo de coleção, ele atualizará ou excluirá o usuário em que attribute\_value está em attribute\_name.

Obrigatório junto com *attribute\_name*. | | auth\_source | string | Escolhas:
- auto(default)
- cli
- credential\_file
- env
- msi | Controla a origem das credenciais a serem usadas para autenticação.

Também pode ser definido por `ATMOSPHERE_AZURE_AUTH_SOURCE` meio da variável de ambiente.

Quando definido como `auto`(o padrão), a precedência são os parâmetros do módulo -> `env`-> `credential_file`-> `cli`.

Quando definido como `env`, as credenciais serão lidas a partir das variáveis ​​de ambiente

Quando definido como `credential_file`, ele lerá o perfil de `~/.azure/credentials`.

Quando definido como `cli`, as credenciais serão fontes do perfil da CLI do Azure. `subscription_id` ou a variável de ambiente `AZURE_SUBSCRIPTION_ID` pode ser usada para identificar o ID da assinatura se mais de um estiver presente, caso contrário, a assinatura az cli padrão será usada.

Quando definido como `msi`, a máquina host deve ser um recurso azure com uma extensão MSI habilitada. `subscription_id` ou a variável de ambiente `AZURE_SUBSCRIPTION_ID` pode ser usada para identificar o ID da assinatura se o recurso tiver acesso concedido a mais de uma assinatura, caso contrário, a primeira assinatura será escolhida. | | cert\_validation\_mode | string | Escolhas:
- ignore
- validate | Controla o comportamento de validação de certificado para pontos de extremidade do Azure. Por padrão, todos os módulos validarão o certificado do servidor, mas quando um proxy HTTPS está em uso ou na pilha do Azure, pode ser necessário desabilitar esse comportamento passando ignore. Também pode ser definido por meio de perfil de arquivo de credencial ou `AZURE_CERT_VALIDATION` variável de ambiente. | | client\_id | string | | ID de cliente do Azure. Use ao autenticar com um responsável pelo serviço. | | cloud\_environment | string | Default:
"AzureCloud" | Para outros do que a nuvem pública US ambientes de nuvem, o nome do ambiente (como definido pelo Azure SDK para Python, por exemplo, `AzureChinaCloud`, `AzureUSGovernment`), ou um URL do terminal de descoberta de metadados (necessário para Azure Stack). Também pode ser definido por meio de perfil de arquivo de credencial ou `AZURE_CLOUD_ENVIRONMENT` variável de ambiente. | | display\_name | string | | O nome de exibição do usuário.

Usado ao criar ou atualizar uma conta de usuário. | | given\_name | string | | O nome fornecido para o usuário.

Usado ao criar ou atualizar uma conta de usuário. | | immutable\_id | string | | O immutable\_id do usuário.

Usado ao criar ou atualizar uma conta de usuário. | | log\_mode | string | | Argumento dos pais. | | log\_path | string | | Argumento dos pais. | | mail | string | | O endereço de e-mail principal do usuário.

Usado ao criar ou atualizar uma conta de usuário. | | mail\_nickname | string | | O alias de e-mail do usuário.

Usado ao criar ou atualizar uma conta de usuário. | | object\_id | string | | O ID do objeto para o usuário.Atualiza ou exclui o usuário que possui este ID de objeto.

Mutuamente exclusivo com *user\_principal\_name* , *attribute\_name* e *odata\_filter* . | | odata\_filter | string | | Filtro que pode ser usado para especificar um usuário para atualizar ou excluir.

Mutuamente exclusivo com *object\_id* , *attribute\_name* e *user\_principal\_name* . | | password | string | | Senha de usuário do Active Directory. Use ao autenticar com um usuário do Active Directory em vez do principal de serviço. | | password\_profile | string | | A senha do usuário.

Usado ao criar ou atualizar uma conta de usuário. | | profile | string | | Perfil de segurança encontrado no arquivo \~ / .azure / credentials. | | secret | string | | Segredo do cliente Azure. Use ao autenticar com um responsável pelo serviço. | | state | string | Escolhas:
- absent
- present
(default) | Estado do usuário do anúncio. Use presentpara criar ou atualizar um usuário de anúncio e absentpara excluir um usuário de anúncio. | | subscription\_id | string | | Seu ID de assinatura do Azure. | | surname | string | | O sobrenome do usuário.Usado ao criar ou atualizar uma conta de usuário. | | tenant - required | string | | O ID do inquilino. | | usage\_location | string | | Um código de país de duas letras, padrão ISO 3166.

Obrigatório para um usuário que receberá licenças devido a requisitos legais para verificar a disponibilidade de serviços nos países.

Usado ao criar ou atualizar uma conta de usuário. | | user\_principal\_name | string | | O nome principal do usuário.

Cria, atualiza ou exclui o usuário que possui este nome principal.

Mutuamente exclusivo com *object\_id*, *attribute\_name* e *odata\_filter* . | | user\_type | string | | Um valor de string que pode ser usado para classificar os tipos de usuário em seu diretório, como Membro e Convidado.

Usado ao criar ou atualizar uma conta de usuário. | ## Notas Observação - Para autenticação com o Azure, você pode passar parâmetros, definir variáveis ​​de ambiente, usar um perfil armazenado em \~ / .azure / credentials ou fazer logon antes de executar suas tarefas ou manual com `az login`. - A autenticação também é possível usando uma entidade de serviço ou usuário do Active Directory. - Para autenticar por meio do principal de serviço, passe subscription\_id, client\_id, secret e tenant ou defina as variáveis ​​de ambiente AZURE\_SUBSCRIPTION\_ID, AZURE\_CLIENT\_ID, AZURE\_SECRET e AZURE\_TENANT. - Para autenticar por meio do usuário do Active Directory, passe ad\_user e senha ou defina AZURE\_AD\_USER e AZURE\_PASSWORD no ambiente. - Como alternativa, as credenciais podem ser armazenadas em \~ / .azure / credentials. Este é um arquivo ini contendo uma seção \[padrão] e as seguintes chaves: subscription\_id, client\_id, secret e tenant ou subscription\_id, ad\_user e senha. Também é possível adicionar perfis adicionais. Especifique o perfil passando o perfil ou definindo AZURE\_PROFILE no ambiente. ## Exemplos ```yaml - name: Criar usuário azure_rm_aduser: user_principal_name: "{{ user_id }}" tenant: "{{ tenant_id }}" state: "present" account_enabled: "True" display_name: "Test_{{ user_principal_name }}_Display_Name" password_profile: "password" mail_nickname: "Test_{{ user_principal_name }}_mail_nickname" immutable_id: "{{ object_id }}" given_name: "First" surname: "Last" user_type: "Member" usage_location: "US" mail: "{{ user_principal_name }}@contoso.com" - name: Atualize o usuário com o novo valor para account_enabled azure_rm_aduser: user_principal_name: "{{ user_id }}" tenant: "{{ tenant_id }}" state: "present" account_enabled: "False" - name: Deletar usuário azure_rm_aduser: user_principal_name: "{{ user_id }}" tenant: "{{ tenant_id }}" state: "absent" ``` ## Valores Retornados | **Chave** | **Tipo** | **Retornado quando** | **Descrição** | | --------------------- | -------- | -------------------- | -------------------------------------------------------------------------------------------- | | account\_enabled | boolean | sempre | Se a conta está habilitada.
| | display\_name | string | sempre | O nome de exibição do usuário. | | mail | string | sempre | O endereço de e-mail principal do usuário. | | mail\_nickname | string | sempre | O alias de e-mail do usuário. | | object\_id | string | sempre | O object\_id para o usuário. | | user\_principal\_name | string | sempre | O nome principal do usuário. | | user\_type | string | sempre | Um valor de string que pode ser usado para classificar os tipos de usuário em seu diretório. |