Modifier

Partager via


Update-AzNetAppFilesActiveDirectory

Updates an Azure NetApp Files (ANF) active directory configuration to the optional modifiers provided.

Syntax

Update-AzNetAppFilesActiveDirectory
      -ResourceGroupName <String>
      -AccountName <String>
      -ActiveDirectoryId <String>
      [-Dns <String[]>]
      [-Domain <String>]
      [-Site <String>]
      [-SmbServerName <String>]
      [-Username <String>]
      [-Password <SecureString>]
      [-OrganizationalUnit <String>]
      [-KdcIP <String>]
      [-BackupOperator <String[]>]
      [-ServerRootCACertificate <String>]
      [-AdName <String>]
      [-SecurityOperator <String[]>]
      [-AesEncryption]
      [-LdapSigning]
      [-LdapOverTLS]
      [-AllowLocalNfsUsersWithLdap]
      [-Administrator <String[]>]
      [-EncryptDCConnection]
      [-LdapSearchScope <PSNetAppFilesLdapSearchScopeOpt>]
      [-PreferredServersForLdapClient <String[]>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzNetAppFilesActiveDirectory
      -ActiveDirectoryId <String>
      [-Dns <String[]>]
      [-Domain <String>]
      [-Site <String>]
      [-SmbServerName <String>]
      [-Username <String>]
      [-Password <SecureString>]
      [-OrganizationalUnit <String>]
      [-KdcIP <String>]
      [-BackupOperator <String[]>]
      [-ServerRootCACertificate <String>]
      [-AdName <String>]
      [-SecurityOperator <String[]>]
      [-AesEncryption]
      [-LdapSigning]
      [-LdapOverTLS]
      [-AllowLocalNfsUsersWithLdap]
      [-Administrator <String[]>]
      [-EncryptDCConnection]
      [-LdapSearchScope <PSNetAppFilesLdapSearchScopeOpt>]
      [-PreferredServersForLdapClient <String[]>]
      -AccountObject <PSNetAppFilesAccount>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzNetAppFilesActiveDirectory
      [-Dns <String[]>]
      [-Domain <String>]
      [-Site <String>]
      [-SmbServerName <String>]
      [-Username <String>]
      [-Password <SecureString>]
      [-OrganizationalUnit <String>]
      [-KdcIP <String>]
      [-BackupOperator <String[]>]
      [-ServerRootCACertificate <String>]
      [-AdName <String>]
      [-SecurityOperator <String[]>]
      [-AesEncryption]
      [-LdapSigning]
      [-LdapOverTLS]
      [-AllowLocalNfsUsersWithLdap]
      [-Administrator <String[]>]
      [-EncryptDCConnection]
      [-LdapSearchScope <PSNetAppFilesLdapSearchScopeOpt>]
      [-PreferredServersForLdapClient <String[]>]
      -InputObject <PSNetAppFilesActiveDirectory>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Update-AzNetAppFilesActiveDirectory cmdlet modifies an ANF active directory configuration.

Examples

Example 1

Update-AzNetAppFilesActiveDirectory  -ResourceGroupName "MyRG" -AccountName "MyAccount" -AdName "MyADName" -Username "AdUserName"

This command performs an update on the given active directory configuration modifying the username to that provided.

Parameters

-AccountName

The name of the ANF account

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-AccountObject

The account for the active directory object

Type:PSNetAppFilesAccount
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ActiveDirectoryId

The ID of the ANF active directory

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Administrator

Domain Users to be added to the Built-in Administrators Active Directory group. A list of unique usernames without domain specifier.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AdName

Name of the active directory machine. This optional parameter is used only while creating kerberos volume

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AesEncryption

When AES is enabled, set if AES encryption will be enabled for SMB communication.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AllowLocalNfsUsersWithLdap

If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BackupOperator

Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Dns

Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Domain

Name of the Active Directory domain

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EncryptDCConnection

If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

The active directory object to remove

Type:PSNetAppFilesActiveDirectory
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-KdcIP

kdc server IP addresses for the active directory machine. This optional parameter is used only while creating kerberos volume.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LdapOverTLS

When LDAP over SSL/TLS is enabled, specifies whether or not the LDAP traffic needs to be secured via TLS.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LdapSearchScope

LDAP Search scope options.

Type:PSNetAppFilesLdapSearchScopeOpt
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LdapSigning

When LDAP over SSL/TLS is enabled, Specifies whether or not the LDAP traffic needs to be signed.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OrganizationalUnit

The Organizational Unit (OU) within the Windows Active Directory

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Password

Plain text password of Active Directory domain administrator, value is masked in the response

Type:SecureString
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PreferredServersForLdapClient

Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The resource group of the ANF account

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SecurityOperator

Domain Users in the Active directory to be given Security Privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServerRootCACertificate

When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Site

The Active Directory site the service will limit Domain Controller discovery to

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SmbServerName

NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Username

A domain user account with permission to create machine accounts

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSNetAppFilesAccount

PSNetAppFilesActiveDirectory

Outputs

PSNetAppFilesActiveDirectory