你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Connectors - Update

服务:: Storage Resource Provider

API 版本:: 2025-08-01

更新存储连接器。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/connectors/{connectorName}?api-version=2025-08-01

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-z0-9]+$	指定资源组中的存储帐户的名称。存储帐户名称长度必须介于 3 到 24 个字符之间，并且仅使用数字和小写字母。
connectorName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9](?!.*--)[a-z0-9-]{1,61}[a-z0-9]$	存储连接器的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求正文

名称	类型	说明
properties	StorageConnectorPropertiesUpdate	存储连接器的特性。
tags	object	资源标记。

响应

名称	类型	说明
200 OK	Connector	Azure 运营顺利完成。
202 Accepted		接受资源更新请求。标头 Location: string Retry-After: integer
Other Status Codes	ErrorResponse	意外的错误响应。

名称

类型

说明

200 OK

Connector

Azure 运营顺利完成。

202 Accepted

接受资源更新请求。

标头

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流程。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

UpdateConnector

示例请求

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/teststorageaccount/connectors/testconnector?api-version=2025-08-01

{
  "properties": {
    "source": {
      "type": "DataShare",
      "authProperties": {
        "type": "ManagedIdentity",
        "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/newTestIdentity"
      }
    }
  }
}

示例响应

状态代码:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/teststorageaccount/connectors/testconnector",
  "name": "testconnector",
  "type": "Microsoft.Storage/storageAccounts/connectors",
  "location": "eastus",
  "properties": {
    "uniqueId": "12345678-1234-1234-1234-12345678912",
    "state": "Active",
    "creationTime": "2023-04-01T00:00:00Z",
    "description": "Example connector",
    "dataSourceType": "Azure_DataShare",
    "source": {
      "type": "DataShare",
      "connection": {
        "type": "DataShare",
        "dataShareUri": "azds://eastus:datashare1:12345678-1234-1234-1234-123456789123"
      },
      "authProperties": {
        "type": "ManagedIdentity",
        "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/newTestIdentity"
      }
    },
    "provisioningState": "Succeeded"
  }
}

状态代码:: 202

Location: https://management.azure.com/subscriptions/xxxx/resourceGroups/rg-name/providers/Microsoft.Storage/operations/operation-98765
Retry-After: 30

定义

名称	说明
Connector	连接器是一种被跟踪的ARM资源，建模为存储账户的子资源。
ConnectorUpdate	连接器是一种被跟踪的ARM资源，建模为存储账户的子资源。
createdByType	创建资源的标识的类型。
DataShareConnection	Data Share 源的连接详情
DataShareSource	数据共享源的属性
DataShareSourceUpdate	数据共享源的属性
ErrorResponse	存储资源提供程序的错误响应。
ErrorResponseBody	错误响应正文协定。
ManagedIdentityAuthProperties	dataShare连接的管理身份认证属性。
ManagedIdentityAuthPropertiesUpdate	dataShare连接的管理身份认证属性。
NativeDataSharingProvisioningState	调用作时资源的配置状态。
StorageConnectorAuthType	认证类型支持存储连接器中的桶连接。
StorageConnectorConnectionType	存储连接器中桶连接的连接类型。
StorageConnectorDataSourceType	存储连接器的后备数据源类型
StorageConnectorProperties	存储连接器的属性
StorageConnectorPropertiesUpdate	存储连接器的属性
StorageConnectorSourceType	存储连接器的后备数据源类型
StorageConnectorState	州级 - 活跃或非活跃。存储连接器是否应以激活状态开始（默认：活跃）（在存储连接器上设置为false时，使用该存储连接器的所有数据平面请求都会失败，且如果该存储连接器会计费，则不会计费。
systemData	与创建和上次修改资源相关的元数据。

Connector

对象

连接器是一种被跟踪的ARM资源，建模为存储账户的子资源。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
location	string	资源所在的地理位置
name	string	资源的名称
properties	StorageConnectorProperties	存储连接器的特性。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ConnectorUpdate

对象

连接器是一种被跟踪的ARM资源，建模为存储账户的子资源。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties	StorageConnectorPropertiesUpdate	存储连接器的特性。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

DataShareConnection

对象

Data Share 源的连接详情

名称	类型	说明
dataShareUri	string pattern: ^azds://[a-zA-Z0-9-]+:[a-zA-Z0-9-_]+:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$	支持DataShare的URI。格式必须为：azds://< region>：<DataShareName>：<DataShareIdentifier>
type	string: DataShare	连接的类型。控制连接对象的类型。一旦创建存储连接器，就无法变动。

DataShareSource

对象

数据共享源的属性

名称	类型	说明
authProperties	StorageConnectorAuthProperties: ManagedIdentityAuthProperties	关于如何向备份数据存储进行认证的详细信息。
connection	StorageConnectorConnection: DataShareConnection	关于如何连接备份数据存储的详细信息。
type	string: DataShare	存储连接器的类型。一旦存储连接器被创建，就无法变更。”

DataShareSourceUpdate

对象

数据共享源的属性

名称	类型	说明
authProperties	StorageConnectorAuthPropertiesUpdate: ManagedIdentityAuthPropertiesUpdate	关于如何向备份数据存储进行认证的详细信息。
type	string: DataShare	存储连接器的类型。一旦存储连接器被创建，就无法变更。”

ErrorResponse

对象

存储资源提供程序的错误响应。

名称	类型	说明
error	ErrorResponseBody	Azure Storage Resource Provider error response body.

ErrorResponseBody

对象

错误响应正文协定。

名称	类型	说明
code	string	错误的标识符。代码是固定的，旨在以编程方式使用。
message	string	描述错误的消息，旨在适合在用户界面中显示。

ManagedIdentityAuthProperties

对象

dataShare连接的管理身份认证属性。

名称	类型	说明
identityResourceId	string	管理身份的ARM ResourceId，用于向后台数据源进行认证。
type	string: ManagedIdentity	认证属性的类型。控制 authProperties 对象的类型

ManagedIdentityAuthPropertiesUpdate

对象

dataShare连接的管理身份认证属性。

名称	类型	说明
identityResourceId	string	管理身份的ARM ResourceId，用于向后台数据源进行认证。
type	string: ManagedIdentity	认证属性的类型。控制 authProperties 对象的类型

NativeDataSharingProvisioningState

枚举

调用作时资源的配置状态。

值	说明
Accepted	该请求已被接受处理。
Creating	正在创建资源。
Succeeded	该资源已经成功创建。
Deleting	正在删除此资源。
Canceled	已取消请求。
Failed	资源创建或删除失败了。

StorageConnectorAuthType

枚举

认证类型支持存储连接器中的桶连接。

值	说明
ManagedIdentity	托管身份认证类型

StorageConnectorConnectionType

枚举

存储连接器中桶连接的连接类型。

值	说明
DataShare	DataShare 连接类型

StorageConnectorDataSourceType

枚举

存储连接器的后备数据源类型

值	说明
Azure_DataShare	Azure DataShare 数据源类型。

StorageConnectorProperties

对象

存储连接器的属性

名称	类型	默认值	说明
creationTime	string		存储连接器的系统生成时间，采用ISO 8601日期-时间格式（YYYY-MM-DDTHH：mm：ssZ）。在创作过程中，这并不是一个有效的输入参数。
dataSourceType	StorageConnectorDataSourceType		该存储连接器的后备数据源类型。
description	string maxLength: 250		对该存储连接器的任意描述。最多250字符。
provisioningState	NativeDataSharingProvisioningState		表示存储连接器的配置状态。
source	StorageConnectorSource: DataShareSource		关于如何与备份数据存储通信和认证的信息。
state	StorageConnectorState	Active	州级 - 活跃或非活跃。存储连接器是否应以激活状态开始（默认：活跃）（在存储连接器上设置为false时，使用该存储连接器的所有数据平面请求都会失败，且如果该存储连接器会计费，则不会计费。
testConnection	boolean	False	在创建存储连接器之前，先测试与备份数据源的连接。
uniqueId	string		存储连接器系统生成的GUID标识符。创建时这不是有效的输入参数。

StorageConnectorPropertiesUpdate

对象

存储连接器的属性

名称	类型	默认值	说明
description	string maxLength: 250		对该存储连接器的任意描述。最多250字符。
source	StorageConnectorSourceUpdate: DataShareSourceUpdate		关于如何与备份数据存储通信和认证的信息。
state	StorageConnectorState	Active	州级 - 活跃或非活跃。存储连接器是否应以激活状态开始（默认：活跃）（在存储连接器上设置为false时，使用该存储连接器的所有数据平面请求都会失败，且如果该存储连接器会计费，则不会计费。
testConnection	boolean	False	在创建存储连接器之前，先测试与备份数据源的连接。

StorageConnectorSourceType

枚举

存储连接器的后备数据源类型

值	说明
DataShare	源类型 - DataShare

StorageConnectorState

枚举

州级 - 活跃或非活跃。存储连接器是否应以激活状态开始（默认：活跃）（在存储连接器上设置为false时，使用该存储连接器的所有数据平面请求都会失败，且如果该存储连接器会计费，则不会计费。

值	说明
Active	连接器是否处于激活状态
Inactive	连接器是否处于非激活状态

systemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	资源上次修改的时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

通过

Connectors - Update

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

UpdateConnector

示例请求

示例响应

定义

Connector

ConnectorUpdate

createdByType

DataShareConnection

DataShareSource

DataShareSourceUpdate

ErrorResponse

ErrorResponseBody

ManagedIdentityAuthProperties

ManagedIdentityAuthPropertiesUpdate

NativeDataSharingProvisioningState

StorageConnectorAuthType

StorageConnectorConnectionType

StorageConnectorDataSourceType

StorageConnectorProperties

StorageConnectorPropertiesUpdate

StorageConnectorSourceType

StorageConnectorState

systemData