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

Microsoft.Security 连接器

项目
10/24/2024

Bicep 资源定义

可以使用目标操作部署连接器资源类型：

订阅 - 请参阅订阅部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Security/connectors 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Security/connectors@2020-01-01-preview' = {
  name: 'string'
  properties: {
    authenticationDetails: {
      authenticationType: 'string'
      // For remaining properties, see AuthenticationDetailsProperties objects
    }
    hybridComputeSettings: {
      autoProvision: 'string'
      proxyServer: {
        ip: 'string'
        port: 'string'
      }
      region: 'string'
      resourceGroupName: 'string'
      servicePrincipal: {
        applicationId: 'string'
        secret: 'string'
      }
    }
  }
}

AuthenticationDetailsProperties 对象

设置 authenticationType 属性以指定对象的类型。

对于 awsAssumeRole，请使用：

{
  authenticationType: 'awsAssumeRole'
  awsAssumeRoleArn: 'string'
  awsExternalId: 'string'
}

对于 awsCreds，请使用：

{
  authenticationType: 'awsCreds'
  awsAccessKeyId: 'string'
  awsSecretAccessKey: 'string'
}

对于 gcpCredentials，请使用：

{
  authenticationType: 'gcpCredentials'
  authProviderX509CertUrl: 'string'
  authUri: 'string'
  clientEmail: 'string'
  clientId: 'string'
  clientX509CertUrl: 'string'
  organizationId: 'string'
  privateKey: 'string'
  privateKeyId: 'string'
  projectId: 'string'
  tokenUri: 'string'
  type: 'string'
}

属性值

AuthenticationDetailsProperties

名字	描述	价值
authenticationType	对于 AwAssumeRoleAuthenticationDetailsProperties，请设置为“awsAssumeRole”。对于 AwsCredsAuthenticationDetailsProperties类型，设置为“awsCreds”。对于类型 GcpCredentialsDetailsProperties，设置为“gcpCredentials”。	'awsAssumeRole' “awsCreds” “gcpCredentials”（必需）

AwAssumeRoleAuthenticationDetailsProperties

名字	描述	价值
authenticationType	连接到云帐户，以便 AWS 使用帐户凭据或基于角色的身份验证。对于 GCP，请使用帐户组织凭据。	“awsAssumeRole”（必需）
awsAssumeRoleArn	假定的角色 ID 是可用于创建临时安全凭据的标识符。	string （必需）
awsExternalId	在另一帐户中担任角色时所需的唯一标识符。	string （必需）

AwsCredsAuthenticationDetailsProperties

名字	描述	价值
authenticationType	连接到云帐户，以便 AWS 使用帐户凭据或基于角色的身份验证。对于 GCP，请使用帐户组织凭据。	“awsCreds”（必需）
awsAccessKeyId	AWS 凭据对象的公钥元素（仅写入）	string （必需）
awsSecretAccessKey	AWS 凭据对象的密钥元素（仅写入）	string （必需）

ConnectorSettingProperties

名字	描述	价值
authenticationDetails	身份验证管理的设置，这些设置仅与云连接器相关。	AuthenticationDetailsProperties
hybridComputeSettings	混合计算管理的设置。这些设置仅适用于 Arc autoProvision（混合计算）。	HybridComputeSettingsProperties

GcpCredentialsDetailsProperties

名字	描述	价值
authenticationType	连接到云帐户，以便 AWS 使用帐户凭据或基于角色的身份验证。对于 GCP，请使用帐户组织凭据。	“gcpCredentials”（必需）
authProviderX509CertUrl	API 密钥的身份验证提供程序 x509 证书 URL 字段（仅写入）	string （必需）
authUri	API 密钥的身份验证 URI 字段（仅写入）	string （必需）
clientEmail	API 密钥的客户端电子邮件字段（仅写入）	string （必需）
clientId	API 密钥的客户端 ID 字段（仅写入）	string （必需）
clientX509CertUrl	API 密钥的客户端 x509 证书 URL 字段（仅写入）	string （必需）
organizationId	GCP 云帐户的组织 ID	string （必需）
privateKey	API 密钥的私钥字段（仅写入）	string （必需）
privateKeyId	API 密钥的私钥 ID 字段（仅写入）	string （必需）
projectId	API 密钥的项目 ID 字段（仅写入）	string （必需）
tokenUri	API 密钥的令牌 URI 字段（仅写入）	string （必需）
类型	API 密钥的类型字段（仅写入）	string （必需）

HybridComputeSettingsProperties

名字	描述	价值
autoProvision	是否在计算机上安装 Azure Arc（混合计算）代理	“关闭” “开”（必需）
proxyServer	对于未直接连接到 Internet 的非 Azure 计算机，请指定非 Azure 计算机可以使用的代理服务器。	ProxyServerProperties
地区	将存储计算机元数据的位置	字符串
resourceGroupName	连接 Arc（混合计算）连接器的资源组的名称。	字符串
servicePrincipal	用于访问受 Azure AD 租户保护的资源的对象。	ServicePrincipalProperties

Microsoft.Security/connectors

名字	描述	价值
名字	资源名称	string （必需）
性能	连接器设置数据	ConnectorSettingProperties

ProxyServerProperties

名字	描述	价值
ip	代理服务器 IP	字符串
港口	代理服务器端口	字符串

ServicePrincipalProperties

名字	描述	价值
applicationId	服务主体的应用程序 ID。	字符串
秘密	应用程序用来证明其标识的机密字符串，也可以称为应用程序密码（仅写入）。	字符串

ARM 模板资源定义

可以使用目标操作部署连接器资源类型：

订阅 - 请参阅订阅部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Security/connectors 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Security/connectors",
  "apiVersion": "2020-01-01-preview",
  "name": "string",
  "properties": {
    "authenticationDetails": {
      "authenticationType": "string"
      // For remaining properties, see AuthenticationDetailsProperties objects
    },
    "hybridComputeSettings": {
      "autoProvision": "string",
      "proxyServer": {
        "ip": "string",
        "port": "string"
      },
      "region": "string",
      "resourceGroupName": "string",
      "servicePrincipal": {
        "applicationId": "string",
        "secret": "string"
      }
    }
  }
}

AuthenticationDetailsProperties 对象

设置 authenticationType 属性以指定对象的类型。

对于 awsAssumeRole，请使用：

{
  "authenticationType": "awsAssumeRole",
  "awsAssumeRoleArn": "string",
  "awsExternalId": "string"
}

对于 awsCreds，请使用：

{
  "authenticationType": "awsCreds",
  "awsAccessKeyId": "string",
  "awsSecretAccessKey": "string"
}

对于 gcpCredentials，请使用：

{
  "authenticationType": "gcpCredentials",
  "authProviderX509CertUrl": "string",
  "authUri": "string",
  "clientEmail": "string",
  "clientId": "string",
  "clientX509CertUrl": "string",
  "organizationId": "string",
  "privateKey": "string",
  "privateKeyId": "string",
  "projectId": "string",
  "tokenUri": "string",
  "type": "string"
}

属性值

AuthenticationDetailsProperties

名字	描述	价值
authenticationType	对于 AwAssumeRoleAuthenticationDetailsProperties，请设置为“awsAssumeRole”。对于 AwsCredsAuthenticationDetailsProperties类型，设置为“awsCreds”。对于类型 GcpCredentialsDetailsProperties，设置为“gcpCredentials”。	'awsAssumeRole' “awsCreds” “gcpCredentials”（必需）

AwAssumeRoleAuthenticationDetailsProperties

名字	描述	价值
authenticationType	连接到云帐户，以便 AWS 使用帐户凭据或基于角色的身份验证。对于 GCP，请使用帐户组织凭据。	“awsAssumeRole”（必需）
awsAssumeRoleArn	假定的角色 ID 是可用于创建临时安全凭据的标识符。	string （必需）
awsExternalId	在另一帐户中担任角色时所需的唯一标识符。	string （必需）

AwsCredsAuthenticationDetailsProperties

名字	描述	价值
authenticationType	连接到云帐户，以便 AWS 使用帐户凭据或基于角色的身份验证。对于 GCP，请使用帐户组织凭据。	“awsCreds”（必需）
awsAccessKeyId	AWS 凭据对象的公钥元素（仅写入）	string （必需）
awsSecretAccessKey	AWS 凭据对象的密钥元素（仅写入）	string （必需）

ConnectorSettingProperties

名字	描述	价值
authenticationDetails	身份验证管理的设置，这些设置仅与云连接器相关。	AuthenticationDetailsProperties
hybridComputeSettings	混合计算管理的设置。这些设置仅适用于 Arc autoProvision（混合计算）。	HybridComputeSettingsProperties

GcpCredentialsDetailsProperties

名字	描述	价值
authenticationType	连接到云帐户，以便 AWS 使用帐户凭据或基于角色的身份验证。对于 GCP，请使用帐户组织凭据。	“gcpCredentials”（必需）
authProviderX509CertUrl	API 密钥的身份验证提供程序 x509 证书 URL 字段（仅写入）	string （必需）
authUri	API 密钥的身份验证 URI 字段（仅写入）	string （必需）
clientEmail	API 密钥的客户端电子邮件字段（仅写入）	string （必需）
clientId	API 密钥的客户端 ID 字段（仅写入）	string （必需）
clientX509CertUrl	API 密钥的客户端 x509 证书 URL 字段（仅写入）	string （必需）
organizationId	GCP 云帐户的组织 ID	string （必需）
privateKey	API 密钥的私钥字段（仅写入）	string （必需）
privateKeyId	API 密钥的私钥 ID 字段（仅写入）	string （必需）
projectId	API 密钥的项目 ID 字段（仅写入）	string （必需）
tokenUri	API 密钥的令牌 URI 字段（仅写入）	string （必需）
类型	API 密钥的类型字段（仅写入）	string （必需）

HybridComputeSettingsProperties

名字	描述	价值
autoProvision	是否在计算机上安装 Azure Arc（混合计算）代理	“关闭” “开”（必需）
proxyServer	对于未直接连接到 Internet 的非 Azure 计算机，请指定非 Azure 计算机可以使用的代理服务器。	ProxyServerProperties
地区	将存储计算机元数据的位置	字符串
resourceGroupName	连接 Arc（混合计算）连接器的资源组的名称。	字符串
servicePrincipal	用于访问受 Azure AD 租户保护的资源的对象。	ServicePrincipalProperties

Microsoft.Security/connectors

名字	描述	价值
apiVersion	API 版本	'2020-01-01-preview'
名字	资源名称	string （必需）
性能	连接器设置数据	ConnectorSettingProperties
类型	资源类型	“Microsoft.Security/connectors”

ProxyServerProperties

名字	描述	价值
ip	代理服务器 IP	字符串
港口	代理服务器端口	字符串

ServicePrincipalProperties

名字	描述	价值
applicationId	服务主体的应用程序 ID。	字符串
秘密	应用程序用来证明其标识的机密字符串，也可以称为应用程序密码（仅写入）。	字符串

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署连接器资源类型：

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Security/connectors 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Security/connectors@2020-01-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      authenticationDetails = {
        authenticationType = "string"
        // For remaining properties, see AuthenticationDetailsProperties objects
      }
      hybridComputeSettings = {
        autoProvision = "string"
        proxyServer = {
          ip = "string"
          port = "string"
        }
        region = "string"
        resourceGroupName = "string"
        servicePrincipal = {
          applicationId = "string"
          secret = "string"
        }
      }
    }
  })
}

AuthenticationDetailsProperties 对象

设置 authenticationType 属性以指定对象的类型。

对于 awsAssumeRole，请使用：

{
  authenticationType = "awsAssumeRole"
  awsAssumeRoleArn = "string"
  awsExternalId = "string"
}

对于 awsCreds，请使用：

{
  authenticationType = "awsCreds"
  awsAccessKeyId = "string"
  awsSecretAccessKey = "string"
}

对于 gcpCredentials，请使用：

{
  authenticationType = "gcpCredentials"
  authProviderX509CertUrl = "string"
  authUri = "string"
  clientEmail = "string"
  clientId = "string"
  clientX509CertUrl = "string"
  organizationId = "string"
  privateKey = "string"
  privateKeyId = "string"
  projectId = "string"
  tokenUri = "string"
  type = "string"
}

属性值

AuthenticationDetailsProperties

名字	描述	价值
authenticationType	对于 AwAssumeRoleAuthenticationDetailsProperties，请设置为“awsAssumeRole”。对于 AwsCredsAuthenticationDetailsProperties类型，设置为“awsCreds”。对于类型 GcpCredentialsDetailsProperties，设置为“gcpCredentials”。	'awsAssumeRole' “awsCreds” “gcpCredentials”（必需）

AwAssumeRoleAuthenticationDetailsProperties

名字	描述	价值
authenticationType	连接到云帐户，以便 AWS 使用帐户凭据或基于角色的身份验证。对于 GCP，请使用帐户组织凭据。	“awsAssumeRole”（必需）
awsAssumeRoleArn	假定的角色 ID 是可用于创建临时安全凭据的标识符。	string （必需）
awsExternalId	在另一帐户中担任角色时所需的唯一标识符。	string （必需）

AwsCredsAuthenticationDetailsProperties

名字	描述	价值
authenticationType	连接到云帐户，以便 AWS 使用帐户凭据或基于角色的身份验证。对于 GCP，请使用帐户组织凭据。	“awsCreds”（必需）
awsAccessKeyId	AWS 凭据对象的公钥元素（仅写入）	string （必需）
awsSecretAccessKey	AWS 凭据对象的密钥元素（仅写入）	string （必需）

ConnectorSettingProperties

名字	描述	价值
authenticationDetails	身份验证管理的设置，这些设置仅与云连接器相关。	AuthenticationDetailsProperties
hybridComputeSettings	混合计算管理的设置。这些设置仅适用于 Arc autoProvision（混合计算）。	HybridComputeSettingsProperties

GcpCredentialsDetailsProperties

名字	描述	价值
authenticationType	连接到云帐户，以便 AWS 使用帐户凭据或基于角色的身份验证。对于 GCP，请使用帐户组织凭据。	“gcpCredentials”（必需）
authProviderX509CertUrl	API 密钥的身份验证提供程序 x509 证书 URL 字段（仅写入）	string （必需）
authUri	API 密钥的身份验证 URI 字段（仅写入）	string （必需）
clientEmail	API 密钥的客户端电子邮件字段（仅写入）	string （必需）
clientId	API 密钥的客户端 ID 字段（仅写入）	string （必需）
clientX509CertUrl	API 密钥的客户端 x509 证书 URL 字段（仅写入）	string （必需）
organizationId	GCP 云帐户的组织 ID	string （必需）
privateKey	API 密钥的私钥字段（仅写入）	string （必需）
privateKeyId	API 密钥的私钥 ID 字段（仅写入）	string （必需）
projectId	API 密钥的项目 ID 字段（仅写入）	string （必需）
tokenUri	API 密钥的令牌 URI 字段（仅写入）	string （必需）
类型	API 密钥的类型字段（仅写入）	string （必需）

HybridComputeSettingsProperties

名字	描述	价值
autoProvision	是否在计算机上安装 Azure Arc（混合计算）代理	“关闭” “开”（必需）
proxyServer	对于未直接连接到 Internet 的非 Azure 计算机，请指定非 Azure 计算机可以使用的代理服务器。	ProxyServerProperties
地区	将存储计算机元数据的位置	字符串
resourceGroupName	连接 Arc（混合计算）连接器的资源组的名称。	字符串
servicePrincipal	用于访问受 Azure AD 租户保护的资源的对象。	ServicePrincipalProperties

Microsoft.Security/connectors

名字	描述	价值
名字	资源名称	string （必需）
性能	连接器设置数据	ConnectorSettingProperties
类型	资源类型	“Microsoft.Security/connectors@2020-01-01-preview”

ProxyServerProperties

名字	描述	价值
ip	代理服务器 IP	字符串
港口	代理服务器端口	字符串

ServicePrincipalProperties

名字	描述	价值
applicationId	服务主体的应用程序 ID。	字符串
秘密	应用程序用来证明其标识的机密字符串，也可以称为应用程序密码（仅写入）。	字符串

通过

Microsoft.Security 连接器

Bicep 资源定义

资源格式

AuthenticationDetailsProperties 对象

属性值

AuthenticationDetailsProperties

AwAssumeRoleAuthenticationDetailsProperties

AwsCredsAuthenticationDetailsProperties

ConnectorSettingProperties

GcpCredentialsDetailsProperties

HybridComputeSettingsProperties

Microsoft.Security/connectors

ProxyServerProperties

ServicePrincipalProperties

ARM 模板资源定义

资源格式

AuthenticationDetailsProperties 对象

属性值

AuthenticationDetailsProperties

AwAssumeRoleAuthenticationDetailsProperties

AwsCredsAuthenticationDetailsProperties

ConnectorSettingProperties

GcpCredentialsDetailsProperties

HybridComputeSettingsProperties

Microsoft.Security/connectors

ProxyServerProperties

ServicePrincipalProperties

Terraform （AzAPI 提供程序）资源定义

资源格式

AuthenticationDetailsProperties 对象

属性值

AuthenticationDetailsProperties

AwAssumeRoleAuthenticationDetailsProperties

AwsCredsAuthenticationDetailsProperties

ConnectorSettingProperties

GcpCredentialsDetailsProperties

HybridComputeSettingsProperties

Microsoft.Security/connectors

ProxyServerProperties

ServicePrincipalProperties

反馈

其他资源