Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Azure Native
  4. API Docs
  5. storage
  6. getDataShare
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.23.0
published on Saturday, Jul 18, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.storage.getDataShare

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.23.0
published on Saturday, Jul 18, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    Get the specified Storage DataShare.

    Uses Azure REST API version 2025-08-01.

    Other available API versions: 2026-04-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native storage [ApiVersion]. See the version guide for details.

    Using getDataShare

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDataShare(args: GetDataShareArgs, opts?: InvokeOptions): Promise<GetDataShareResult>
function getDataShareOutput(args: GetDataShareOutputArgs, opts?: InvokeOptions): Output<GetDataShareResult>
    def get_data_share(account_name: Optional[str] = None,
                   data_share_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDataShareResult
def get_data_share_output(account_name: pulumi.Input[Optional[str]] = None,
                   data_share_name: pulumi.Input[Optional[str]] = None,
                   resource_group_name: pulumi.Input[Optional[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDataShareResult]
    func LookupDataShare(ctx *Context, args *LookupDataShareArgs, opts ...InvokeOption) (*LookupDataShareResult, error)
func LookupDataShareOutput(ctx *Context, args *LookupDataShareOutputArgs, opts ...InvokeOption) LookupDataShareResultOutput

    > Note: This function is named LookupDataShare in the Go SDK.

    public static class GetDataShare 
{
    public static Task<GetDataShareResult> InvokeAsync(GetDataShareArgs args, InvokeOptions? opts = null)
    public static Output<GetDataShareResult> Invoke(GetDataShareInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDataShareResult> getDataShare(GetDataShareArgs args, InvokeOptions options)
public static Output<GetDataShareResult> getDataShare(GetDataShareArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:storage:getDataShare
  arguments:
    # arguments dictionary
    data "azure-native_storage_get_data_share" "name" {
    # arguments
}

    The following arguments are supported:

    AccountName string
    The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
    DataShareName string
    The name of the Storage DataShare.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AccountName string
    The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
    DataShareName string
    The name of the Storage DataShare.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    account_name string
    The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
    data_share_name string
    The name of the Storage DataShare.
    resource_group_name string
    The name of the resource group. The name is case insensitive.
    accountName String
    The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
    dataShareName String
    The name of the Storage DataShare.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    accountName string
    The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
    dataShareName string
    The name of the Storage DataShare.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    account_name str
    The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
    data_share_name str
    The name of the Storage DataShare.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    accountName String
    The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
    dataShareName String
    The name of the Storage DataShare.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getDataShare Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.Storage.Outputs.StorageDataSharePropertiesResponse
    The properties of the Storage DataShare.
    SystemData Pulumi.AzureNative.Storage.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties StorageDataSharePropertiesResponse
    The properties of the Storage DataShare.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Tags map[string]string
    Resource tags.
    azure_api_version string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties object
    The properties of the Storage DataShare.
    system_data object
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags map(string)
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties StorageDataSharePropertiesResponse
    The properties of the Storage DataShare.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties StorageDataSharePropertiesResponse
    The properties of the Storage DataShare.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    properties StorageDataSharePropertiesResponse
    The properties of the Storage DataShare.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties Property Map
    The properties of the Storage DataShare.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Map<String>
    Resource tags.

    Supporting Types

    StorageDataShareAccessPolicyResponse

    Permission string
    Allowed permissions. Currently, only supported value is Read.
    PrincipalId string
    The AAD principal ID of the Managed Identity.
    TenantId string
    The AAD tenant ID of the Managed Identity.
    Permission string
    Allowed permissions. Currently, only supported value is Read.
    PrincipalId string
    The AAD principal ID of the Managed Identity.
    TenantId string
    The AAD tenant ID of the Managed Identity.
    permission string
    Allowed permissions. Currently, only supported value is Read.
    principal_id string
    The AAD principal ID of the Managed Identity.
    tenant_id string
    The AAD tenant ID of the Managed Identity.
    permission String
    Allowed permissions. Currently, only supported value is Read.
    principalId String
    The AAD principal ID of the Managed Identity.
    tenantId String
    The AAD tenant ID of the Managed Identity.
    permission string
    Allowed permissions. Currently, only supported value is Read.
    principalId string
    The AAD principal ID of the Managed Identity.
    tenantId string
    The AAD tenant ID of the Managed Identity.
    permission str
    Allowed permissions. Currently, only supported value is Read.
    principal_id str
    The AAD principal ID of the Managed Identity.
    tenant_id str
    The AAD tenant ID of the Managed Identity.
    permission String
    Allowed permissions. Currently, only supported value is Read.
    principalId String
    The AAD principal ID of the Managed Identity.
    tenantId String
    The AAD tenant ID of the Managed Identity.

    StorageDataShareAssetResponse

    AssetPath string
    Source Path to be shared. It can be a folder or a blob. The asset path should contain container name followed by path within the container, e.g. /container1/logs/external.
    DisplayName string
    Consumer visible name of the original path.
    AssetPath string
    Source Path to be shared. It can be a folder or a blob. The asset path should contain container name followed by path within the container, e.g. /container1/logs/external.
    DisplayName string
    Consumer visible name of the original path.
    asset_path string
    Source Path to be shared. It can be a folder or a blob. The asset path should contain container name followed by path within the container, e.g. /container1/logs/external.
    display_name string
    Consumer visible name of the original path.
    assetPath String
    Source Path to be shared. It can be a folder or a blob. The asset path should contain container name followed by path within the container, e.g. /container1/logs/external.
    displayName String
    Consumer visible name of the original path.
    assetPath string
    Source Path to be shared. It can be a folder or a blob. The asset path should contain container name followed by path within the container, e.g. /container1/logs/external.
    displayName string
    Consumer visible name of the original path.
    asset_path str
    Source Path to be shared. It can be a folder or a blob. The asset path should contain container name followed by path within the container, e.g. /container1/logs/external.
    display_name str
    Consumer visible name of the original path.
    assetPath String
    Source Path to be shared. It can be a folder or a blob. The asset path should contain container name followed by path within the container, e.g. /container1/logs/external.
    displayName String
    Consumer visible name of the original path.

    StorageDataSharePropertiesResponse

    AccessPolicies List<Pulumi.AzureNative.Storage.Inputs.StorageDataShareAccessPolicyResponse>
    List of access policies that specify the permission allowed to a managed identity. For Create - This property is required and cannot be null. If no access policies are provided at creation time, specify an empty array. For Update - This property is optional. If set to null or not passed, the existing access policies are left unchanged. If provided with a non-null value, the existing access policies are replaced with the specified list.
    Assets List<Pulumi.AzureNative.Storage.Inputs.StorageDataShareAssetResponse>
    List of assets that specify the properties of the shared resources. For Create - This property is required and cannot be null. If no assets are provided at creation time, specify an empty array. For Update - This property is optional. If set to null or not passed, the existing assets are left unchanged. If provided with a non-null value, the existing assets are replaced with the specified list.
    DataShareIdentifier string
    System-generated GUID identifier for the Storage DataShare. Not a valid input parameter when creating.
    DataShareUri string
    The DataShare URI to be shared with the consumer. URI Format - 'azds://::'.
    ProvisioningState string
    Represents the provisioning state of the storage datashare.
    Description string
    Arbitrary description of this Data Share. Max 250 characters.
    AccessPolicies []StorageDataShareAccessPolicyResponse
    List of access policies that specify the permission allowed to a managed identity. For Create - This property is required and cannot be null. If no access policies are provided at creation time, specify an empty array. For Update - This property is optional. If set to null or not passed, the existing access policies are left unchanged. If provided with a non-null value, the existing access policies are replaced with the specified list.
    Assets []StorageDataShareAssetResponse
    List of assets that specify the properties of the shared resources. For Create - This property is required and cannot be null. If no assets are provided at creation time, specify an empty array. For Update - This property is optional. If set to null or not passed, the existing assets are left unchanged. If provided with a non-null value, the existing assets are replaced with the specified list.
    DataShareIdentifier string
    System-generated GUID identifier for the Storage DataShare. Not a valid input parameter when creating.
    DataShareUri string
    The DataShare URI to be shared with the consumer. URI Format - 'azds://::'.
    ProvisioningState string
    Represents the provisioning state of the storage datashare.
    Description string
    Arbitrary description of this Data Share. Max 250 characters.
    access_policies list(object)
    List of access policies that specify the permission allowed to a managed identity. For Create - This property is required and cannot be null. If no access policies are provided at creation time, specify an empty array. For Update - This property is optional. If set to null or not passed, the existing access policies are left unchanged. If provided with a non-null value, the existing access policies are replaced with the specified list.
    assets list(object)
    List of assets that specify the properties of the shared resources. For Create - This property is required and cannot be null. If no assets are provided at creation time, specify an empty array. For Update - This property is optional. If set to null or not passed, the existing assets are left unchanged. If provided with a non-null value, the existing assets are replaced with the specified list.
    data_share_identifier string
    System-generated GUID identifier for the Storage DataShare. Not a valid input parameter when creating.
    data_share_uri string
    The DataShare URI to be shared with the consumer. URI Format - 'azds://::'.
    provisioning_state string
    Represents the provisioning state of the storage datashare.
    description string
    Arbitrary description of this Data Share. Max 250 characters.
    accessPolicies List<StorageDataShareAccessPolicyResponse>
    List of access policies that specify the permission allowed to a managed identity. For Create - This property is required and cannot be null. If no access policies are provided at creation time, specify an empty array. For Update - This property is optional. If set to null or not passed, the existing access policies are left unchanged. If provided with a non-null value, the existing access policies are replaced with the specified list.
    assets List<StorageDataShareAssetResponse>
    List of assets that specify the properties of the shared resources. For Create - This property is required and cannot be null. If no assets are provided at creation time, specify an empty array. For Update - This property is optional. If set to null or not passed, the existing assets are left unchanged. If provided with a non-null value, the existing assets are replaced with the specified list.
    dataShareIdentifier String
    System-generated GUID identifier for the Storage DataShare. Not a valid input parameter when creating.
    dataShareUri String
    The DataShare URI to be shared with the consumer. URI Format - 'azds://::'.
    provisioningState String
    Represents the provisioning state of the storage datashare.
    description String
    Arbitrary description of this Data Share. Max 250 characters.
    accessPolicies StorageDataShareAccessPolicyResponse[]
    List of access policies that specify the permission allowed to a managed identity. For Create - This property is required and cannot be null. If no access policies are provided at creation time, specify an empty array. For Update - This property is optional. If set to null or not passed, the existing access policies are left unchanged. If provided with a non-null value, the existing access policies are replaced with the specified list.
    assets StorageDataShareAssetResponse[]
    List of assets that specify the properties of the shared resources. For Create - This property is required and cannot be null. If no assets are provided at creation time, specify an empty array. For Update - This property is optional. If set to null or not passed, the existing assets are left unchanged. If provided with a non-null value, the existing assets are replaced with the specified list.
    dataShareIdentifier string
    System-generated GUID identifier for the Storage DataShare. Not a valid input parameter when creating.
    dataShareUri string
    The DataShare URI to be shared with the consumer. URI Format - 'azds://::'.
    provisioningState string
    Represents the provisioning state of the storage datashare.
    description string
    Arbitrary description of this Data Share. Max 250 characters.
    access_policies Sequence[StorageDataShareAccessPolicyResponse]
    List of access policies that specify the permission allowed to a managed identity. For Create - This property is required and cannot be null. If no access policies are provided at creation time, specify an empty array. For Update - This property is optional. If set to null or not passed, the existing access policies are left unchanged. If provided with a non-null value, the existing access policies are replaced with the specified list.
    assets Sequence[StorageDataShareAssetResponse]
    List of assets that specify the properties of the shared resources. For Create - This property is required and cannot be null. If no assets are provided at creation time, specify an empty array. For Update - This property is optional. If set to null or not passed, the existing assets are left unchanged. If provided with a non-null value, the existing assets are replaced with the specified list.
    data_share_identifier str
    System-generated GUID identifier for the Storage DataShare. Not a valid input parameter when creating.
    data_share_uri str
    The DataShare URI to be shared with the consumer. URI Format - 'azds://::'.
    provisioning_state str
    Represents the provisioning state of the storage datashare.
    description str
    Arbitrary description of this Data Share. Max 250 characters.
    accessPolicies List<Property Map>
    List of access policies that specify the permission allowed to a managed identity. For Create - This property is required and cannot be null. If no access policies are provided at creation time, specify an empty array. For Update - This property is optional. If set to null or not passed, the existing access policies are left unchanged. If provided with a non-null value, the existing access policies are replaced with the specified list.
    assets List<Property Map>
    List of assets that specify the properties of the shared resources. For Create - This property is required and cannot be null. If no assets are provided at creation time, specify an empty array. For Update - This property is optional. If set to null or not passed, the existing assets are left unchanged. If provided with a non-null value, the existing assets are replaced with the specified list.
    dataShareIdentifier String
    System-generated GUID identifier for the Storage DataShare. Not a valid input parameter when creating.
    dataShareUri String
    The DataShare URI to be shared with the consumer. URI Format - 'azds://::'.
    provisioningState String
    Represents the provisioning state of the storage datashare.
    description String
    Arbitrary description of this Data Share. Max 250 characters.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    created_at string
    The timestamp of resource creation (UTC).
    created_by string
    The identity that created the resource.
    created_by_type string
    The type of identity that created the resource.
    last_modified_at string
    The timestamp of resource last modification (UTC)
    last_modified_by string
    The identity that last modified the resource.
    last_modified_by_type string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.23.0
    published on Saturday, Jul 18, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial