BucketPatchProperties interface

Bucket resource properties for a Patch operation

Properties

akvDetails

Specifies the Azure Key Vault settings. These are used when a) retrieving the bucket server certificate, and b) storing the bucket credentials

Notes:

  1. If a bucket certificate was previously provided directly using the certificateObject property, it is possible to subsequently use the Azure Key Vault for certificate management by using these 'akvDetails' properties. However, once Azure Key Vault is configured, it is no longer possible to provide the certificate directly via the certificateObject property.
  2. These properties are mutually exclusive with the server.certificateObject property.
fileSystemUser

File System user having access to volume data. For Unix, this is the user's uid and gid. For Windows, this is the user's username. Note that the Unix and Windows user details are mutually exclusive, meaning one or other must be supplied, but not both.

permissions

Access permissions for the bucket. Either ReadOnly or ReadWrite.

provisioningState

Provisioning state of the resource

server

Properties of the server managing the lifecycle of volume buckets

Property Details

akvDetails

Specifies the Azure Key Vault settings. These are used when a) retrieving the bucket server certificate, and b) storing the bucket credentials

Notes:

  1. If a bucket certificate was previously provided directly using the certificateObject property, it is possible to subsequently use the Azure Key Vault for certificate management by using these 'akvDetails' properties. However, once Azure Key Vault is configured, it is no longer possible to provide the certificate directly via the certificateObject property.
  2. These properties are mutually exclusive with the server.certificateObject property.
akvDetails?: AzureKeyVaultDetails

Property Value

fileSystemUser

File System user having access to volume data. For Unix, this is the user's uid and gid. For Windows, this is the user's username. Note that the Unix and Windows user details are mutually exclusive, meaning one or other must be supplied, but not both.

fileSystemUser?: FileSystemUser

Property Value

permissions

Access permissions for the bucket. Either ReadOnly or ReadWrite.

permissions?: string

Property Value

string

provisioningState

Provisioning state of the resource

provisioningState?: string

Property Value

string

server

Properties of the server managing the lifecycle of volume buckets

server?: BucketServerPatchProperties

Property Value