1. Packages
  2. Azure Classic
  3. API Docs
  4. machinelearning
  5. DatastoreFileshare

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.machinelearning.DatastoreFileshare

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    Manages a Machine Learning File Share DataStore.

    Example Usage

    With Azure File Share

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleInsights:
        type: azure:appinsights:Insights
        name: example
        properties:
          name: workspace-example-ai
          location: ${example.location}
          resourceGroupName: ${example.name}
          applicationType: web
      exampleKeyVault:
        type: azure:keyvault:KeyVault
        name: example
        properties:
          name: workspaceexamplekeyvault
          location: ${example.location}
          resourceGroupName: ${example.name}
          tenantId: ${current.tenantId}
          skuName: premium
      exampleAccount:
        type: azure:storage:Account
        name: example
        properties:
          name: workspacestorageaccount
          location: ${example.location}
          resourceGroupName: ${example.name}
          accountTier: Standard
          accountReplicationType: GRS
      exampleWorkspace:
        type: azure:machinelearning:Workspace
        name: example
        properties:
          name: example-workspace
          location: ${example.location}
          resourceGroupName: ${example.name}
          applicationInsightsId: ${exampleInsights.id}
          keyVaultId: ${exampleKeyVault.id}
          storageAccountId: ${exampleAccount.id}
          identity:
            type: SystemAssigned
      exampleShare:
        type: azure:storage:Share
        name: example
        properties:
          name: example
          storageAccountName: ${exampleAccount.name}
          quota: 1
      exampleDatastoreFileshare:
        type: azure:machinelearning:DatastoreFileshare
        name: example
        properties:
          name: example-datastore
          workspaceId: ${exampleWorkspace.id}
          storageFilesahareId: ${test.resourceManagerId}
          accountKey: ${exampleAccount.primaryAccessKey}
    variables:
      current:
        fn::invoke:
          Function: azure:core:getClientConfig
          Arguments: {}
    

    Create DatastoreFileshare Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DatastoreFileshare(name: string, args: DatastoreFileshareArgs, opts?: CustomResourceOptions);
    @overload
    def DatastoreFileshare(resource_name: str,
                           args: DatastoreFileshareArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def DatastoreFileshare(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           storage_fileshare_id: Optional[str] = None,
                           workspace_id: Optional[str] = None,
                           account_key: Optional[str] = None,
                           description: Optional[str] = None,
                           name: Optional[str] = None,
                           service_data_identity: Optional[str] = None,
                           shared_access_signature: Optional[str] = None,
                           tags: Optional[Mapping[str, str]] = None)
    func NewDatastoreFileshare(ctx *Context, name string, args DatastoreFileshareArgs, opts ...ResourceOption) (*DatastoreFileshare, error)
    public DatastoreFileshare(string name, DatastoreFileshareArgs args, CustomResourceOptions? opts = null)
    public DatastoreFileshare(String name, DatastoreFileshareArgs args)
    public DatastoreFileshare(String name, DatastoreFileshareArgs args, CustomResourceOptions options)
    
    type: azure:machinelearning:DatastoreFileshare
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DatastoreFileshareArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DatastoreFileshareArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DatastoreFileshareArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatastoreFileshareArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatastoreFileshareArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var datastoreFileshareResource = new Azure.MachineLearning.DatastoreFileshare("datastoreFileshareResource", new()
    {
        StorageFileshareId = "string",
        WorkspaceId = "string",
        AccountKey = "string",
        Description = "string",
        Name = "string",
        ServiceDataIdentity = "string",
        SharedAccessSignature = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := machinelearning.NewDatastoreFileshare(ctx, "datastoreFileshareResource", &machinelearning.DatastoreFileshareArgs{
    	StorageFileshareId:    pulumi.String("string"),
    	WorkspaceId:           pulumi.String("string"),
    	AccountKey:            pulumi.String("string"),
    	Description:           pulumi.String("string"),
    	Name:                  pulumi.String("string"),
    	ServiceDataIdentity:   pulumi.String("string"),
    	SharedAccessSignature: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var datastoreFileshareResource = new DatastoreFileshare("datastoreFileshareResource", DatastoreFileshareArgs.builder()
        .storageFileshareId("string")
        .workspaceId("string")
        .accountKey("string")
        .description("string")
        .name("string")
        .serviceDataIdentity("string")
        .sharedAccessSignature("string")
        .tags(Map.of("string", "string"))
        .build());
    
    datastore_fileshare_resource = azure.machinelearning.DatastoreFileshare("datastoreFileshareResource",
        storage_fileshare_id="string",
        workspace_id="string",
        account_key="string",
        description="string",
        name="string",
        service_data_identity="string",
        shared_access_signature="string",
        tags={
            "string": "string",
        })
    
    const datastoreFileshareResource = new azure.machinelearning.DatastoreFileshare("datastoreFileshareResource", {
        storageFileshareId: "string",
        workspaceId: "string",
        accountKey: "string",
        description: "string",
        name: "string",
        serviceDataIdentity: "string",
        sharedAccessSignature: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure:machinelearning:DatastoreFileshare
    properties:
        accountKey: string
        description: string
        name: string
        serviceDataIdentity: string
        sharedAccessSignature: string
        storageFileshareId: string
        tags:
            string: string
        workspaceId: string
    

    DatastoreFileshare Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The DatastoreFileshare resource accepts the following input properties:

    StorageFileshareId string
    The ID of the Storage Account File Share. Changing this forces a new Machine Learning DataStore to be created.
    WorkspaceId string
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning DataStore to be created.
    AccountKey string
    The access key of the Storage Account. Conflicts with shared_access_signature.
    Description string
    Text used to describe the asset. Changing this forces a new Machine Learning DataStore to be created.
    Name string
    The name of the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    ServiceDataIdentity string
    Specifies which identity to use when retrieving data from the specified source. Defaults to None. Possible values are None, WorkspaceSystemAssignedIdentity and WorkspaceUserAssignedIdentity.
    SharedAccessSignature string
    The Shared Access Signature of the Storage Account. Conflicts with account_key.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    StorageFileshareId string
    The ID of the Storage Account File Share. Changing this forces a new Machine Learning DataStore to be created.
    WorkspaceId string
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning DataStore to be created.
    AccountKey string
    The access key of the Storage Account. Conflicts with shared_access_signature.
    Description string
    Text used to describe the asset. Changing this forces a new Machine Learning DataStore to be created.
    Name string
    The name of the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    ServiceDataIdentity string
    Specifies which identity to use when retrieving data from the specified source. Defaults to None. Possible values are None, WorkspaceSystemAssignedIdentity and WorkspaceUserAssignedIdentity.
    SharedAccessSignature string
    The Shared Access Signature of the Storage Account. Conflicts with account_key.
    Tags map[string]string
    A mapping of tags which should be assigned to the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    storageFileshareId String
    The ID of the Storage Account File Share. Changing this forces a new Machine Learning DataStore to be created.
    workspaceId String
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning DataStore to be created.
    accountKey String
    The access key of the Storage Account. Conflicts with shared_access_signature.
    description String
    Text used to describe the asset. Changing this forces a new Machine Learning DataStore to be created.
    name String
    The name of the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    serviceDataIdentity String
    Specifies which identity to use when retrieving data from the specified source. Defaults to None. Possible values are None, WorkspaceSystemAssignedIdentity and WorkspaceUserAssignedIdentity.
    sharedAccessSignature String
    The Shared Access Signature of the Storage Account. Conflicts with account_key.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    storageFileshareId string
    The ID of the Storage Account File Share. Changing this forces a new Machine Learning DataStore to be created.
    workspaceId string
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning DataStore to be created.
    accountKey string
    The access key of the Storage Account. Conflicts with shared_access_signature.
    description string
    Text used to describe the asset. Changing this forces a new Machine Learning DataStore to be created.
    name string
    The name of the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    serviceDataIdentity string
    Specifies which identity to use when retrieving data from the specified source. Defaults to None. Possible values are None, WorkspaceSystemAssignedIdentity and WorkspaceUserAssignedIdentity.
    sharedAccessSignature string
    The Shared Access Signature of the Storage Account. Conflicts with account_key.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    storage_fileshare_id str
    The ID of the Storage Account File Share. Changing this forces a new Machine Learning DataStore to be created.
    workspace_id str
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning DataStore to be created.
    account_key str
    The access key of the Storage Account. Conflicts with shared_access_signature.
    description str
    Text used to describe the asset. Changing this forces a new Machine Learning DataStore to be created.
    name str
    The name of the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    service_data_identity str
    Specifies which identity to use when retrieving data from the specified source. Defaults to None. Possible values are None, WorkspaceSystemAssignedIdentity and WorkspaceUserAssignedIdentity.
    shared_access_signature str
    The Shared Access Signature of the Storage Account. Conflicts with account_key.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    storageFileshareId String
    The ID of the Storage Account File Share. Changing this forces a new Machine Learning DataStore to be created.
    workspaceId String
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning DataStore to be created.
    accountKey String
    The access key of the Storage Account. Conflicts with shared_access_signature.
    description String
    Text used to describe the asset. Changing this forces a new Machine Learning DataStore to be created.
    name String
    The name of the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    serviceDataIdentity String
    Specifies which identity to use when retrieving data from the specified source. Defaults to None. Possible values are None, WorkspaceSystemAssignedIdentity and WorkspaceUserAssignedIdentity.
    sharedAccessSignature String
    The Shared Access Signature of the Storage Account. Conflicts with account_key.
    tags Map<String>
    A mapping of tags which should be assigned to the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DatastoreFileshare resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    IsDefault bool
    Indicate whether this Machines Learning DataStore is the default for the Workspace.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDefault bool
    Indicate whether this Machines Learning DataStore is the default for the Workspace.
    id String
    The provider-assigned unique ID for this managed resource.
    isDefault Boolean
    Indicate whether this Machines Learning DataStore is the default for the Workspace.
    id string
    The provider-assigned unique ID for this managed resource.
    isDefault boolean
    Indicate whether this Machines Learning DataStore is the default for the Workspace.
    id str
    The provider-assigned unique ID for this managed resource.
    is_default bool
    Indicate whether this Machines Learning DataStore is the default for the Workspace.
    id String
    The provider-assigned unique ID for this managed resource.
    isDefault Boolean
    Indicate whether this Machines Learning DataStore is the default for the Workspace.

    Look up Existing DatastoreFileshare Resource

    Get an existing DatastoreFileshare resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DatastoreFileshareState, opts?: CustomResourceOptions): DatastoreFileshare
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_key: Optional[str] = None,
            description: Optional[str] = None,
            is_default: Optional[bool] = None,
            name: Optional[str] = None,
            service_data_identity: Optional[str] = None,
            shared_access_signature: Optional[str] = None,
            storage_fileshare_id: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            workspace_id: Optional[str] = None) -> DatastoreFileshare
    func GetDatastoreFileshare(ctx *Context, name string, id IDInput, state *DatastoreFileshareState, opts ...ResourceOption) (*DatastoreFileshare, error)
    public static DatastoreFileshare Get(string name, Input<string> id, DatastoreFileshareState? state, CustomResourceOptions? opts = null)
    public static DatastoreFileshare get(String name, Output<String> id, DatastoreFileshareState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountKey string
    The access key of the Storage Account. Conflicts with shared_access_signature.
    Description string
    Text used to describe the asset. Changing this forces a new Machine Learning DataStore to be created.
    IsDefault bool
    Indicate whether this Machines Learning DataStore is the default for the Workspace.
    Name string
    The name of the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    ServiceDataIdentity string
    Specifies which identity to use when retrieving data from the specified source. Defaults to None. Possible values are None, WorkspaceSystemAssignedIdentity and WorkspaceUserAssignedIdentity.
    SharedAccessSignature string
    The Shared Access Signature of the Storage Account. Conflicts with account_key.
    StorageFileshareId string
    The ID of the Storage Account File Share. Changing this forces a new Machine Learning DataStore to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    WorkspaceId string
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning DataStore to be created.
    AccountKey string
    The access key of the Storage Account. Conflicts with shared_access_signature.
    Description string
    Text used to describe the asset. Changing this forces a new Machine Learning DataStore to be created.
    IsDefault bool
    Indicate whether this Machines Learning DataStore is the default for the Workspace.
    Name string
    The name of the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    ServiceDataIdentity string
    Specifies which identity to use when retrieving data from the specified source. Defaults to None. Possible values are None, WorkspaceSystemAssignedIdentity and WorkspaceUserAssignedIdentity.
    SharedAccessSignature string
    The Shared Access Signature of the Storage Account. Conflicts with account_key.
    StorageFileshareId string
    The ID of the Storage Account File Share. Changing this forces a new Machine Learning DataStore to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    WorkspaceId string
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning DataStore to be created.
    accountKey String
    The access key of the Storage Account. Conflicts with shared_access_signature.
    description String
    Text used to describe the asset. Changing this forces a new Machine Learning DataStore to be created.
    isDefault Boolean
    Indicate whether this Machines Learning DataStore is the default for the Workspace.
    name String
    The name of the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    serviceDataIdentity String
    Specifies which identity to use when retrieving data from the specified source. Defaults to None. Possible values are None, WorkspaceSystemAssignedIdentity and WorkspaceUserAssignedIdentity.
    sharedAccessSignature String
    The Shared Access Signature of the Storage Account. Conflicts with account_key.
    storageFileshareId String
    The ID of the Storage Account File Share. Changing this forces a new Machine Learning DataStore to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    workspaceId String
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning DataStore to be created.
    accountKey string
    The access key of the Storage Account. Conflicts with shared_access_signature.
    description string
    Text used to describe the asset. Changing this forces a new Machine Learning DataStore to be created.
    isDefault boolean
    Indicate whether this Machines Learning DataStore is the default for the Workspace.
    name string
    The name of the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    serviceDataIdentity string
    Specifies which identity to use when retrieving data from the specified source. Defaults to None. Possible values are None, WorkspaceSystemAssignedIdentity and WorkspaceUserAssignedIdentity.
    sharedAccessSignature string
    The Shared Access Signature of the Storage Account. Conflicts with account_key.
    storageFileshareId string
    The ID of the Storage Account File Share. Changing this forces a new Machine Learning DataStore to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    workspaceId string
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning DataStore to be created.
    account_key str
    The access key of the Storage Account. Conflicts with shared_access_signature.
    description str
    Text used to describe the asset. Changing this forces a new Machine Learning DataStore to be created.
    is_default bool
    Indicate whether this Machines Learning DataStore is the default for the Workspace.
    name str
    The name of the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    service_data_identity str
    Specifies which identity to use when retrieving data from the specified source. Defaults to None. Possible values are None, WorkspaceSystemAssignedIdentity and WorkspaceUserAssignedIdentity.
    shared_access_signature str
    The Shared Access Signature of the Storage Account. Conflicts with account_key.
    storage_fileshare_id str
    The ID of the Storage Account File Share. Changing this forces a new Machine Learning DataStore to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    workspace_id str
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning DataStore to be created.
    accountKey String
    The access key of the Storage Account. Conflicts with shared_access_signature.
    description String
    Text used to describe the asset. Changing this forces a new Machine Learning DataStore to be created.
    isDefault Boolean
    Indicate whether this Machines Learning DataStore is the default for the Workspace.
    name String
    The name of the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    serviceDataIdentity String
    Specifies which identity to use when retrieving data from the specified source. Defaults to None. Possible values are None, WorkspaceSystemAssignedIdentity and WorkspaceUserAssignedIdentity.
    sharedAccessSignature String
    The Shared Access Signature of the Storage Account. Conflicts with account_key.
    storageFileshareId String
    The ID of the Storage Account File Share. Changing this forces a new Machine Learning DataStore to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Machine Learning DataStore. Changing this forces a new Machine Learning DataStore to be created.
    workspaceId String
    The ID of the Machine Learning Workspace. Changing this forces a new Machine Learning DataStore to be created.

    Import

    Machine Learning DataStores can be imported using the resource id, e.g.

    $ pulumi import azure:machinelearning/datastoreFileshare:DatastoreFileshare example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.MachineLearningServices/workspaces/mlw1/dataStores/datastore1
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi