Update-AzNetAppFilesActiveDirectory
This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus .
Updates an Azure NetApp Files (ANF) active directory configuration to the optional modifiers provided.
Syntax
ByFieldsParameterSet (Default)
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>]
ByParentObjectParameterSet
Update-AzNetAppFilesActiveDirectory
-ActiveDirectoryId <String>
-AccountObject <PSNetAppFilesAccount>
[-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>]
ByObjectParameterSet
Update-AzNetAppFilesActiveDirectory
-InputObject <PSNetAppFilesActiveDirectory>
[-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>]
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
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFieldsParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AccountObject
The account for the active directory object
Parameter properties
Parameter sets
ByParentObjectParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-ActiveDirectoryId
The ID of the ANF active directory
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFieldsParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ByParentObjectParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Administrator
Domain Users to be added to the Built-in Administrators Active Directory group. A list of unique usernames without domain specifier.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AdName
Name of the active directory machine.
This optional parameter is used only while creating kerberos volume
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AesEncryption
When AES is enabled, set if AES encryption will be enabled for SMB communication.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AllowLocalNfsUsersWithLdap
If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-BackupOperator
Users to be added to the Built-in Backup Operator active directory group.
A list of unique usernames without domain specifier
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Dns
Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Domain
Name of the Active Directory domain
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EncryptDCConnection
If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
The active directory object to remove
ByObjectParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-KdcIP
kdc server IP addresses for the active directory machine.
This optional parameter is used only while creating kerberos volume.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-LdapOverTLS
When LDAP over SSL/TLS is enabled, specifies whether or not the LDAP traffic needs to be secured via TLS.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-LdapSearchScope
LDAP Search scope options.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-LdapSigning
When LDAP over SSL/TLS is enabled, Specifies whether or not the LDAP traffic needs to be signed.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OrganizationalUnit
The Organizational Unit (OU) within the Windows Active Directory
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Password
Plain text password of Active Directory domain administrator, value is masked in the response
Parameter properties
Type: SecureString
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PreferredServersForLdapClient
Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The resource group of the ANF account
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFieldsParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Site
The Active Directory site the service will limit Domain Controller discovery to
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Username
A domain user account with permission to create machine accounts
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
