Update-AzNetAppFilesBucket
Updates an existing Azure NetApp Files (ANF) Bucket.
Syntax
ByFieldsParameterSet (Default)
Update-AzNetAppFilesBucket
-ResourceGroupName <String>
-AccountName <String>
-PoolName <String>
-VolumeName <String>
-Name <String>
[-Permissions <String>]
[-NfsUserId <Int64>]
[-NfsGroupId <Int64>]
[-CifsUserName <String>]
[-ServerFqdn <String>]
[-ServerCertificateObject <String>]
[-OnCertificateConflictAction <String>]
[-CertificateKeyVaultUri <String>]
[-CertificateName <String>]
[-CredentialsKeyVaultUri <String>]
[-CredentialsSecretName <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByParentObjectParameterSet
Update-AzNetAppFilesBucket
[-Name <String>]
[-Permissions <String>]
[-NfsUserId <Int64>]
[-NfsGroupId <Int64>]
[-CifsUserName <String>]
[-ServerFqdn <String>]
[-ServerCertificateObject <String>]
[-OnCertificateConflictAction <String>]
[-CertificateKeyVaultUri <String>]
[-CertificateName <String>]
[-CredentialsKeyVaultUri <String>]
[-CredentialsSecretName <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByResourceIdParameterSet
Update-AzNetAppFilesBucket
-ResourceId <String>
[-Permissions <String>]
[-NfsUserId <Int64>]
[-NfsGroupId <Int64>]
[-CifsUserName <String>]
[-ServerFqdn <String>]
[-ServerCertificateObject <String>]
[-OnCertificateConflictAction <String>]
[-CertificateKeyVaultUri <String>]
[-CertificateName <String>]
[-CredentialsKeyVaultUri <String>]
[-CredentialsSecretName <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByObjectParameterSet
Update-AzNetAppFilesBucket
-InputObject <PSNetAppFilesBucket>
[-Permissions <String>]
[-NfsUserId <Int64>]
[-NfsGroupId <Int64>]
[-CifsUserName <String>]
[-ServerFqdn <String>]
[-ServerCertificateObject <String>]
[-OnCertificateConflictAction <String>]
[-CertificateKeyVaultUri <String>]
[-CertificateName <String>]
[-CredentialsKeyVaultUri <String>]
[-CredentialsSecretName <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Update-AzNetAppFilesBucket cmdlet patches an existing ANF Bucket. Only the properties supplied as parameters are modified; all others retain their current values. Use this cmdlet to change permissions, rotate the server certificate (inline or via Azure Key Vault), switch the filesystem user identity, or migrate the bucket from inline certificate management to AKV-managed certificate management.
Examples
Example 1: Change bucket permissions and refresh the inline certificate
$newCertObject = [System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes((Get-Content -Raw ./bucket-new.pem)))
Update-AzNetAppFilesBucket -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MyAnfBucket" `
-Permissions "ReadWrite" `
-ServerCertificateObject $newCertObject `
-OnCertificateConflictAction "Update"
Flips the bucket to ReadWrite and re-applies the server certificate using the new PEM blob.
Example 2: Migrate certificate management to Azure Key Vault
Update-AzNetAppFilesBucket -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MyAnfBucket" `
-CertificateKeyVaultUri "https://anf-bucket-certs.vault.azure.net/" -CertificateName "anf-bucket-cert" `
-OnCertificateConflictAction "Update"
Switches the bucket to fetch its server certificate from Azure Key Vault instead of using an inline PEM.
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
-CertificateKeyVaultUri
Base URI of the Azure Key Vault used to retrieve the bucket server certificate.
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
-CertificateName
Name of the bucket server certificate stored in Azure Key Vault.
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
-CifsUserName
CIFS username accessing the bucket data (mutually exclusive with NfsUserId/NfsGroupId).
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
-CredentialsKeyVaultUri
Base URI of the Azure Key Vault used to store the bucket credentials.
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
-CredentialsSecretName
Name of the secret in Azure Key Vault holding the bucket credentials.
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
-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
The bucket object to update
ByObjectParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the ANF bucket
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: BucketName
Parameter sets
ByFieldsParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NfsGroupId
NFS user GID accessing the bucket data.
Parameter properties
Type: Nullable<T> [ Int64 ]
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
-NfsUserId
NFS user UID accessing the bucket data (mutually exclusive with CifsUserName).
Parameter properties
Type: Nullable<T> [ Int64 ]
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
-OnCertificateConflictAction
Action when there is a certificate conflict.
Either Update or Fail.
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
-Permissions
Access permissions for the bucket.
Either ReadOnly or ReadWrite.
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
-PoolName
The name of the ANF capacity pool
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
-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
-ResourceId
The resource id of the ANF bucket
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByResourceIdParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ServerCertificateObject
Base64-encoded contents of the PEM file containing the bucket server certificate and private key.
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
-ServerFqdn
Host part of the bucket URL.
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
-VolumeName
The name of the ANF volume
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
-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
