Azure Storage Accounts Connectors API

The Connectors API from Azure Storage Accounts — 3 operation(s) for connectors.

GitHub OpenAPI

Operations 6

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/connectors Connectors list by storage account #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/connectors/{connectorName} Connectors get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/connectors/{connectorName} Connectors create #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/connectors/{connectorName} Connectors update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/connectors/{connectorName} Connectors delete #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/connectors/{connectorName}/testExistingConnection Connectors test existing connection #

Documentation

Specifications

Schemas & Data

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/azure-storage-accounts:azure-storage-accounts-connectors-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

azure-storage-accounts-connectors-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: StorageManagementClient Connectors API
  version: '2026-09-01'
  description: The Azure Storage Management API.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Connectors
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/connectors
  : get:
      operationId: Connectors_ListByStorageAccount
      tags:
      - Connectors
      description: List all Storage Connectors in a Storage Account.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: 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.
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 3
          pattern: ^[a-z0-9]+$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TypesErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Connectors list by storage account
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/connectors/{connectorName}
  : get:
      operationId: Connectors_Get
      tags:
      - Connectors
      description: Get the specified Storage Connector.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: 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.
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 3
          pattern: ^[a-z0-9]+$
      - name: connectorName
        in: path
        description: The name of the Storage Connector.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[a-z0-9](?!.*--)[a-z0-9-]{1,61}[a-z0-9]$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connector'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TypesErrorResponse'
      summary: Connectors get
      x-summary-source: derived
    put:
      operationId: Connectors_Create
      tags:
      - Connectors
      description: Create a Storage Connector if it does not already exist; otherwise, error out. This API will not allow you to replace an already existing resource.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: 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.
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 3
          pattern: ^[a-z0-9]+$
      - name: connectorName
        in: path
        description: The name of the Storage Connector.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[a-z0-9](?!.*--)[a-z0-9-]{1,61}[a-z0-9]$
      responses:
        '200':
          description: Resource 'Connector' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connector'
        '201':
          description: Resource 'Connector' create operation succeeded
          headers:
            Azure-AsyncOperation:
              description: A link to the status monitor
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connector'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TypesErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
        final-state-schema: '#/definitions/Connector'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Connector'
        description: Create a Storage Connector if it does not already exist; otherwise, error out. This API will not allow you to replace an already existing resource.
        required: true
      summary: Connectors create
      x-summary-source: derived
    patch:
      operationId: Connectors_Update
      tags:
      - Connectors
      description: Update a Storage Connector.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: 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.
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 3
          pattern: ^[a-z0-9]+$
      - name: connectorName
        in: path
        description: The name of the Storage Connector.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[a-z0-9](?!.*--)[a-z0-9-]{1,61}[a-z0-9]$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connector'
        '202':
          description: Resource update request accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TypesErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/Connector'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectorUpdate'
        description: The updated properties of the Storage Connector.
        required: true
      summary: Connectors update
      x-summary-source: derived
    delete:
      operationId: Connectors_Delete
      tags:
      - Connectors
      description: Delete a Storage Connector.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: 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.
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 3
          pattern: ^[a-z0-9]+$
      - name: connectorName
        in: path
        description: The name of the Storage Connector.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[a-z0-9](?!.*--)[a-z0-9-]{1,61}[a-z0-9]$
      responses:
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TypesErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Connectors delete
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/connectors/{connectorName}/testExistingConnection
  : post:
      operationId: Connectors_TestExistingConnection
      tags:
      - Connectors
      description: 'This method is used to verify that the connection to the backing data store works.

        This API is designed to be used for monitoring and debugging purposes. From the caller’s perspective,

        this method does the following: Calls List on the backing data store, attempting to list up to one blob/object/etc.

        If the above succeeds, and if a blob/object/etc is found, calls Get on that object, attempting to download one byte.'
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: 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.
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 3
          pattern: ^[a-z0-9]+$
      - name: connectorName
        in: path
        description: The name of the Storage Connector.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[a-z0-9](?!.*--)[a-z0-9-]{1,61}[a-z0-9]$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestConnectionResponse'
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TypesErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/TestConnectionResponse'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestExistingConnectionRequest'
        description: 'This method is used to verify that the connection to the backing data store works. This API is designed to be used for monitoring and debugging purposes. From the caller’s perspective, this method does the following: Calls List on the backing data store, attempting to list up to one blob/object/etc. If the above succeeds, and if a blob/object/etc is found, calls Get on that object, attempting to download one byte.'
        required: true
      summary: Connectors test existing connection
      x-summary-source: derived
components:
  schemas:
    TrackedResourceUpdate:
      type: object
      description: The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
      properties:
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
      allOf:
      - $ref: '#/components/schemas/Resource'
    ConnectorUpdate:
      type: object
      description: A Connector is a tracked ARM resource modeled as a sub-resource of a Storage Account.
      properties:
        properties:
          $ref: '#/components/schemas/StorageConnectorPropertiesUpdate'
          description: The properties of the Storage Connector.
      allOf:
      - $ref: '#/components/schemas/TrackedResourceUpdate'
    StorageConnectorSourceType:
      type: string
      description: The type of the backing data source for storage connector
      enum:
      - DataShare
      x-ms-enum:
        name: StorageConnectorSourceType
        modelAsString: true
        values:
        - name: DataShare
          value: DataShare
          description: Source type - DataShare
    ConnectorListResult:
      type: object
      description: The response of a Connector list operation.
      properties:
        value:
          type: array
          description: The Connector items on this page
          items:
            $ref: '#/components/schemas/Connector'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    Connector:
      type: object
      description: A Connector is a tracked ARM resource modeled as a sub-resource of a Storage Account.
      properties:
        properties:
          $ref: '#/components/schemas/StorageConnectorProperties'
          description: The properties of the Storage Connector.
      required:
      - properties
      allOf:
      - $ref: '#/components/schemas/TrackedResource'
    StorageConnectorDataSourceType:
      type: string
      description: The type of the backing data source for storage connector
      enum:
      - Azure_DataShare
      x-ms-enum:
        name: StorageConnectorDataSourceType
        modelAsString: true
        values:
        - name: Azure_DataShare
          value: Azure_DataShare
          description: Azure DataShare data source type.
    TypesErrorResponse:
      type: object
      title: Error response
      description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: The error object.
    Resource:
      type: object
      title: Resource
      description: Common fields that are returned in the response for all Azure Resource Manager resources
      properties:
        id:
          type: string
          format: arm-id
          description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
          readOnly: true
        name:
          type: string
          description: The name of the resource
          readOnly: true
        type:
          type: string
          description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
          readOnly: true
        systemData:
          $ref: '#/components/schemas/systemData'
          description: Azure Resource Manager metadata containing createdBy and modifiedBy information.
          readOnly: true
      x-ms-azure-resource: true
    StorageConnectorSourceUpdate:
      type: object
      description: The storage connector backing data source information
      properties:
        type:
          $ref: '#/components/schemas/StorageConnectorSourceType'
          description: Type of the Storage Connector. Not mutable once the Storage Connector is created."
      discriminator:
        propertyName: type
      required:
      - type
    StorageConnectorProperties:
      type: object
      description: The storage connector properties
      properties:
        uniqueId:
          type: string
          description: System-generated GUID identifier for the Storage Connector. Not a valid input parameter when creating.
          readOnly: true
        state:
          type: string
          description: '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.'
          default: Active
          enum:
          - Active
          - Inactive
          x-ms-enum:
            name: StorageConnectorState
            modelAsString: true
            values:
            - name: Active
              value: Active
              description: Whether the connector is active
            - name: Inactive
              value: Inactive
              description: Whether the connector is inactive
        creationTime:
          type: string
          description: '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.'
          readOnly: true
        description:
          type: string
          description: Arbitrary description of this Storage Connector. Max 250 characters.
          maxLength: 250
        testConnection:
          type: boolean
          description: Test connection to backing data source before creating the storage connector.
          default: false
          x-ms-mutability:
          - update
          - create
        dataSourceType:
          $ref: '#/components/schemas/StorageConnectorDataSourceType'
          description: The type of backing data source for this Storage Connector.
          x-ms-mutability:
          - read
          - create
        source:
          $ref: '#/components/schemas/StorageConnectorSource'
          description: Information about how to communicate with and authenticate to the backing data store.
        provisioningState:
          $ref: '#/components/schemas/NativeDataSharingProvisioningState'
          description: Represents the provisioning state of the storage connector.
          readOnly: true
      required:
      - dataSourceType
      - source
    NativeDataSharingProvisioningState:
      type: string
      description: Provisioning state of the resource at the time the operation was called.
      enum:
      - Accepted
      - Creating
      - Succeeded
      - Deleting
      - Canceled
      - Failed
      x-ms-enum:
        name: NativeDataSharingProvisioningState
        modelAsString: true
        values:
        - name: Accepted
          value: Accepted
          description: The request has been accepted for processing.
        - name: Creating
          value: Creating
          description: The resource is being created.
        - name: Succeeded
          value: Succeeded
          description: The resource has been successfully created.
        - name: Deleting
          value: Deleting
          description: The resource is being deleted.
        - name: Canceled
          value: Canceled
          description: The request has been canceled.
        - name: Failed
          value: Failed
          description: The resource creation or deletion has failed.
      readOnly: true
    StorageConnectorSource:
      type: object
      description: The storage connector backing data source information
      properties:
        type:
          $ref: '#/components/schemas/StorageConnectorSourceType'
          description: Type of the Storage Connector. Not mutable once the Storage Connector is created."
      discriminator:
        propertyName: type
      required:
      - type
    TestConnectionResponse:
      type: object
      description: Test connection response properties
      properties:
        storageConnectorMethodName:
          type: string
          description: 'Indicates the method used to validate the connection to the backing data store.

            Valid values are `GetBlob` and `ListBlobs` for failure, and `TestExistingConnection` for success.'
          minLength: 1
        storageConnectorErrorMessage:
          type: string
          description: 'A string representing the error received from the backing data store.

            Format will vary depending on the data store type and will be capped at 1 MB in size.

            The error message will be empty if the connection was successful.'
        storageConnectorRequestId:
          type: string
          description: The request Id associated with the request sent to the backing data store for validation.
          minLength: 1
      required:
      - storageConnectorMethodName
      - storageConnectorRequestId
    TrackedResource:
      type: object
      title: Tracked Resource
      description: The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
      properties:
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
          x-ms-mutability:
          - read
          - create
          - update
        location:
          type: string
          description: The geo-location where the resource lives
          x-ms-mutability:
          - read
          - create
      required:
      - location
      allOf:
      - $ref: '#/components/schemas/Resource'
    TestExistingConnectionRequest:
      type: object
      description: Test existing connection request properties
      properties:
        uniqueId:
          type: string
          description: The uniqueId of the storage connector as returned by the server.
      required:
      - uniqueId
    StorageConnectorPropertiesUpdate:
      type: object
      description: The storage connector properties
      properties:
        state:
          type: string
          description: '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.'
          default: Active
          enum:
          - Active
          - Inactive
          x-ms-enum:
            name: StorageConnectorState
            modelAsString: true
            values:
            - name: Active
              value: Active
              description: Whether the connector is active
            - name: Inactive
              value: Inactive
              description: Whether the connector is inactive
        description:
          type: string
          description: Arbitrary description of this Storage Connector. Max 250 characters.
          maxLength: 250
        testConnection:
          type: boolean
          description: Test connection to backing data source before creating the storage connector.
          default: false
          x-ms-mutability:
          - update
          - create
        source:
          $ref: '#/components/schemas/StorageConnectorSourceUpdate'
          description: Information about how to communicate with and authenticate to the backing data store.
  parameters:
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.