1. Packages
  2. Packages
  3. Azure Native
  4. API Docs
  5. storage
  6. getConnector
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
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

    Get the specified Storage Connector.

    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 getConnector

    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 getConnector(args: GetConnectorArgs, opts?: InvokeOptions): Promise<GetConnectorResult>
    function getConnectorOutput(args: GetConnectorOutputArgs, opts?: InvokeOptions): Output<GetConnectorResult>
    def get_connector(account_name: Optional[str] = None,
                      connector_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetConnectorResult
    def get_connector_output(account_name: pulumi.Input[Optional[str]] = None,
                      connector_name: pulumi.Input[Optional[str]] = None,
                      resource_group_name: pulumi.Input[Optional[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetConnectorResult]
    func LookupConnector(ctx *Context, args *LookupConnectorArgs, opts ...InvokeOption) (*LookupConnectorResult, error)
    func LookupConnectorOutput(ctx *Context, args *LookupConnectorOutputArgs, opts ...InvokeOption) LookupConnectorResultOutput

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

    public static class GetConnector 
    {
        public static Task<GetConnectorResult> InvokeAsync(GetConnectorArgs args, InvokeOptions? opts = null)
        public static Output<GetConnectorResult> Invoke(GetConnectorInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetConnectorResult> getConnector(GetConnectorArgs args, InvokeOptions options)
    public static Output<GetConnectorResult> getConnector(GetConnectorArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:storage:getConnector
      arguments:
        # arguments dictionary
    data "azure-native_storage_get_connector" "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.
    ConnectorName string
    The name of the Storage Connector.
    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.
    ConnectorName string
    The name of the Storage Connector.
    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.
    connector_name string
    The name of the Storage Connector.
    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.
    connectorName String
    The name of the Storage Connector.
    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.
    connectorName string
    The name of the Storage Connector.
    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.
    connector_name str
    The name of the Storage Connector.
    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.
    connectorName String
    The name of the Storage Connector.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getConnector 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.StorageConnectorPropertiesResponse
    The properties of the Storage Connector.
    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 StorageConnectorPropertiesResponse
    The properties of the Storage Connector.
    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 Connector.
    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 StorageConnectorPropertiesResponse
    The properties of the Storage Connector.
    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 StorageConnectorPropertiesResponse
    The properties of the Storage Connector.
    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 StorageConnectorPropertiesResponse
    The properties of the Storage Connector.
    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 Connector.
    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

    DataShareConnectionResponse

    DataShareUri string
    The URI of the backing DataShare. Must be in the format: azds://::
    DataShareUri string
    The URI of the backing DataShare. Must be in the format: azds://::
    data_share_uri string
    The URI of the backing DataShare. Must be in the format: azds://::
    dataShareUri String
    The URI of the backing DataShare. Must be in the format: azds://::
    dataShareUri string
    The URI of the backing DataShare. Must be in the format: azds://::
    data_share_uri str
    The URI of the backing DataShare. Must be in the format: azds://::
    dataShareUri String
    The URI of the backing DataShare. Must be in the format: azds://::

    DataShareSourceResponse

    AuthProperties Pulumi.AzureNative.Storage.Inputs.ManagedIdentityAuthPropertiesResponse
    Details for how to authenticate to the backing data store.
    Connection Pulumi.AzureNative.Storage.Inputs.DataShareConnectionResponse
    Details for how to connect to the backing data store.
    AuthProperties ManagedIdentityAuthPropertiesResponse
    Details for how to authenticate to the backing data store.
    Connection DataShareConnectionResponse
    Details for how to connect to the backing data store.
    auth_properties object
    Details for how to authenticate to the backing data store.
    connection object
    Details for how to connect to the backing data store.
    authProperties ManagedIdentityAuthPropertiesResponse
    Details for how to authenticate to the backing data store.
    connection DataShareConnectionResponse
    Details for how to connect to the backing data store.
    authProperties ManagedIdentityAuthPropertiesResponse
    Details for how to authenticate to the backing data store.
    connection DataShareConnectionResponse
    Details for how to connect to the backing data store.
    auth_properties ManagedIdentityAuthPropertiesResponse
    Details for how to authenticate to the backing data store.
    connection DataShareConnectionResponse
    Details for how to connect to the backing data store.
    authProperties Property Map
    Details for how to authenticate to the backing data store.
    connection Property Map
    Details for how to connect to the backing data store.

    ManagedIdentityAuthPropertiesResponse

    IdentityResourceId string
    ARM ResourceId of the managed identity that should be used to authenticate to the backing data source.
    IdentityResourceId string
    ARM ResourceId of the managed identity that should be used to authenticate to the backing data source.
    identity_resource_id string
    ARM ResourceId of the managed identity that should be used to authenticate to the backing data source.
    identityResourceId String
    ARM ResourceId of the managed identity that should be used to authenticate to the backing data source.
    identityResourceId string
    ARM ResourceId of the managed identity that should be used to authenticate to the backing data source.
    identity_resource_id str
    ARM ResourceId of the managed identity that should be used to authenticate to the backing data source.
    identityResourceId String
    ARM ResourceId of the managed identity that should be used to authenticate to the backing data source.

    StorageConnectorPropertiesResponse

    CreationTime string
    System-generated creation time of the Storage Connector in ISO 8601 date-time format (YYYY-MM-DDTHH:mm:ssZ). Not a valid input parameter during creating.
    DataSourceType string
    The type of backing data source for this Storage Connector.
    ProvisioningState string
    Represents the provisioning state of the storage connector.
    Source Pulumi.AzureNative.Storage.Inputs.DataShareSourceResponse
    Information about how to communicate with and authenticate to the backing data store.
    UniqueId string
    System-generated GUID identifier for the Storage Connector. Not a valid input parameter when creating.
    Description string
    Arbitrary description of this Storage Connector. Max 250 characters.
    State string
    State - Active or Inactive. Whether or not the Storage Connector should start as active (default: Active) (While set to false on the Storage Connector, all data plane requests using this Storage Connector fail, and this Storage Connector is not billed if it would be otherwise.
    CreationTime string
    System-generated creation time of the Storage Connector in ISO 8601 date-time format (YYYY-MM-DDTHH:mm:ssZ). Not a valid input parameter during creating.
    DataSourceType string
    The type of backing data source for this Storage Connector.
    ProvisioningState string
    Represents the provisioning state of the storage connector.
    Source DataShareSourceResponse
    Information about how to communicate with and authenticate to the backing data store.
    UniqueId string
    System-generated GUID identifier for the Storage Connector. Not a valid input parameter when creating.
    Description string
    Arbitrary description of this Storage Connector. Max 250 characters.
    State string
    State - Active or Inactive. Whether or not the Storage Connector should start as active (default: Active) (While set to false on the Storage Connector, all data plane requests using this Storage Connector fail, and this Storage Connector is not billed if it would be otherwise.
    creation_time string
    System-generated creation time of the Storage Connector in ISO 8601 date-time format (YYYY-MM-DDTHH:mm:ssZ). Not a valid input parameter during creating.
    data_source_type string
    The type of backing data source for this Storage Connector.
    provisioning_state string
    Represents the provisioning state of the storage connector.
    source object
    Information about how to communicate with and authenticate to the backing data store.
    unique_id string
    System-generated GUID identifier for the Storage Connector. Not a valid input parameter when creating.
    description string
    Arbitrary description of this Storage Connector. Max 250 characters.
    state string
    State - Active or Inactive. Whether or not the Storage Connector should start as active (default: Active) (While set to false on the Storage Connector, all data plane requests using this Storage Connector fail, and this Storage Connector is not billed if it would be otherwise.
    creationTime String
    System-generated creation time of the Storage Connector in ISO 8601 date-time format (YYYY-MM-DDTHH:mm:ssZ). Not a valid input parameter during creating.
    dataSourceType String
    The type of backing data source for this Storage Connector.
    provisioningState String
    Represents the provisioning state of the storage connector.
    source DataShareSourceResponse
    Information about how to communicate with and authenticate to the backing data store.
    uniqueId String
    System-generated GUID identifier for the Storage Connector. Not a valid input parameter when creating.
    description String
    Arbitrary description of this Storage Connector. Max 250 characters.
    state String
    State - Active or Inactive. Whether or not the Storage Connector should start as active (default: Active) (While set to false on the Storage Connector, all data plane requests using this Storage Connector fail, and this Storage Connector is not billed if it would be otherwise.
    creationTime string
    System-generated creation time of the Storage Connector in ISO 8601 date-time format (YYYY-MM-DDTHH:mm:ssZ). Not a valid input parameter during creating.
    dataSourceType string
    The type of backing data source for this Storage Connector.
    provisioningState string
    Represents the provisioning state of the storage connector.
    source DataShareSourceResponse
    Information about how to communicate with and authenticate to the backing data store.
    uniqueId string
    System-generated GUID identifier for the Storage Connector. Not a valid input parameter when creating.
    description string
    Arbitrary description of this Storage Connector. Max 250 characters.
    state string
    State - Active or Inactive. Whether or not the Storage Connector should start as active (default: Active) (While set to false on the Storage Connector, all data plane requests using this Storage Connector fail, and this Storage Connector is not billed if it would be otherwise.
    creation_time str
    System-generated creation time of the Storage Connector in ISO 8601 date-time format (YYYY-MM-DDTHH:mm:ssZ). Not a valid input parameter during creating.
    data_source_type str
    The type of backing data source for this Storage Connector.
    provisioning_state str
    Represents the provisioning state of the storage connector.
    source DataShareSourceResponse
    Information about how to communicate with and authenticate to the backing data store.
    unique_id str
    System-generated GUID identifier for the Storage Connector. Not a valid input parameter when creating.
    description str
    Arbitrary description of this Storage Connector. Max 250 characters.
    state str
    State - Active or Inactive. Whether or not the Storage Connector should start as active (default: Active) (While set to false on the Storage Connector, all data plane requests using this Storage Connector fail, and this Storage Connector is not billed if it would be otherwise.
    creationTime String
    System-generated creation time of the Storage Connector in ISO 8601 date-time format (YYYY-MM-DDTHH:mm:ssZ). Not a valid input parameter during creating.
    dataSourceType String
    The type of backing data source for this Storage Connector.
    provisioningState String
    Represents the provisioning state of the storage connector.
    source Property Map
    Information about how to communicate with and authenticate to the backing data store.
    uniqueId String
    System-generated GUID identifier for the Storage Connector. Not a valid input parameter when creating.
    description String
    Arbitrary description of this Storage Connector. Max 250 characters.
    state String
    State - Active or Inactive. Whether or not the Storage Connector should start as active (default: Active) (While set to false on the Storage Connector, all data plane requests using this Storage Connector fail, and this Storage Connector is not billed if it would be otherwise.

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial