AzureFileDatastore interface
Azure File datastore configuration.
- Extends
Properties
account |
[Required] Storage account name. |
datastore |
Polymorphic discriminator, which specifies the different types this object can be |
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. |
service |
Indicates which identity to use to authenticate service data access to customer's storage. |
Inherited Properties
credentials | [Required] Account credentials. |
description | The asset description text. |
is |
Readonly property to indicate if datastore is the workspace default datastore NOTE: This property will not be serialized. It can only be populated by the server. |
properties | The asset property dictionary. |
resource |
Azure Resource Group name |
subscription |
Azure Subscription Id |
tags | Tag dictionary. Tags can be added, removed, and updated. |
Property Details
accountName
[Required] Storage account name.
accountName: string
Property Value
string
datastoreType
Polymorphic discriminator, which specifies the different types this object can be
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
serviceDataAccessAuthIdentity
Indicates which identity to use to authenticate service data access to customer's storage.
serviceDataAccessAuthIdentity?: 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 NOTE: This property will not be serialized. It can only be populated by the server.
isDefault?: boolean
Property Value
boolean
Inherited From DatastoreProperties.isDefault
properties
The asset property dictionary.
properties?: {[propertyName: string]: string | null}
Property Value
{[propertyName: string]: string | null}
Inherited From DatastoreProperties.properties
resourceGroup
Azure Resource Group name
resourceGroup?: string
Property Value
string
Inherited From AzureDatastore.resourceGroup
subscriptionId
Azure Subscription Id
subscriptionId?: string
Property Value
string
Inherited From AzureDatastore.subscriptionId
tags
Tag dictionary. Tags can be added, removed, and updated.
tags?: {[propertyName: string]: string | null}
Property Value
{[propertyName: string]: string | null}
Inherited From DatastoreProperties.tags