AzureFileDatastore interface
Azure File datastore configuration.
- Extends
Properties
| account |
[Required] Storage account name. |
| datastore |
[Required] Storage type backing the datastore. |
| endpoint | Azure cloud endpoint for the storage account. |
| file |
[Required] The name of the Azure file share that the datastore points to. |
| protocol | Protocol used to communicate with the storage account. |
| resource |
Azure Resource Group name |
| service |
Indicates which identity to use to authenticate service data access to customer's storage. |
| subscription |
Azure Subscription Id |
Inherited Properties
| credentials | [Required] Account credentials. |
| description | The asset description text. |
| is |
Readonly property to indicate if datastore is the workspace default datastore |
| properties | The asset property dictionary. |
| tags | Tag dictionary. Tags can be added, removed, and updated. |
Property Details
accountName
[Required] Storage account name.
accountName: string
Property Value
string
datastoreType
[Required] Storage type backing the datastore.
datastoreType: "AzureFile"
Property Value
"AzureFile"
endpoint
Azure cloud endpoint for the storage account.
endpoint?: string
Property Value
string
fileShareName
[Required] The name of the Azure file share that the datastore points to.
fileShareName: string
Property Value
string
protocol
Protocol used to communicate with the storage account.
protocol?: string
Property Value
string
resourceGroup
Azure Resource Group name
resourceGroup?: string
Property Value
string
serviceDataAccessAuthIdentity
Indicates which identity to use to authenticate service data access to customer's storage.
serviceDataAccessAuthIdentity?: string
Property Value
string
subscriptionId
Azure Subscription Id
subscriptionId?: string
Property Value
string
Inherited Property Details
credentials
[Required] Account credentials.
credentials: DatastoreCredentialsUnion
Property Value
Inherited From DatastoreProperties.credentials
description
The asset description text.
description?: string
Property Value
string
Inherited From DatastoreProperties.description
isDefault
Readonly property to indicate if datastore is the workspace default datastore
isDefault?: boolean
Property Value
boolean
Inherited From DatastoreProperties.isDefault
properties
The asset property dictionary.
properties?: Record<string, string>
Property Value
Record<string, string>
Inherited From DatastoreProperties.properties
tags
Tag dictionary. Tags can be added, removed, and updated.
tags?: Record<string, string>
Property Value
Record<string, string>
Inherited From DatastoreProperties.tags