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

Microsoft.Security 连接器

项目
01/13/2024

Bicep 资源定义

可以使用面向以下操作部署连接器资源类型：

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

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

资源格式

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

resource symbolicname 'Microsoft.Security/connectors@2020-01-01-preview' = {
  name: 'string'
  properties: {
    authenticationDetails: {
      grantedPermissions: [
        'string'
      ]
      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'

属性值

连接器

名称	说明	值
name	资源名称	字符串 (必需) 字符限制：1-260 有效字符：字母数字、下划线字符和连字符。
properties	连接器设置数据	ConnectorSettingProperties

ConnectorSettingProperties

名称	说明	值
authenticationDetails	身份验证管理设置，这些设置仅与云连接器相关。	AuthenticationDetailsProperties
hybridComputeSettings	混合计算管理的设置。这些设置仅与 Arc autoProvision (混合计算) 相关。	HybridComputeSettingsProperties

AuthenticationDetailsProperties

名称	说明	值
grantedPermissions	在云帐户中检测到的权限。	包含任何一项的字符串数组： “AWS：：AWSSecurityHubReadOnlyAccess” “AWS：：AmazonSSMAutomationRole” “AWS：：SecurityAudit” “GCP：：Security Center 管理员 Viewer”
authenticationType	设置对象类型	awsAssumeRole awsCreds gcpCredentials (必需)

AwAssumeRoleAuthenticationDetailsProperties

名称	说明	值
authenticationType	连接到云帐户，对于 AWS，请使用帐户凭据或基于角色的身份验证。对于 GCP，请使用帐户组织凭据。	需要“awsAssumeRole” ()
awsAssumeRoleArn	假定的角色 ID 是可用于创建临时安全凭据的标识符。	字符串 (必需)
awsExternalId	在另一个帐户中担任角色时所需的唯一标识符。	字符串 (必需)

AwsCredsAuthenticationDetailsProperties

名称	说明	值
authenticationType	连接到云帐户，对于 AWS，请使用帐户凭据或基于角色的身份验证。对于 GCP，请使用帐户组织凭据。	需要“awsCreds” ()
awsAccessKeyId	AWS 凭据对象的公钥元素 (只写入)	字符串 (必需)
awsSecretAccessKey	AWS 凭据对象的机密密钥元素 (只写入)	字符串 (必需)

GcpCredentialsDetailsProperties

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

HybridComputeSettingsProperties

名称	说明	值
autoProvision	是否在计算机上安装 Azure Arc (混合计算) 代理	“Off” “On” (必需)
proxyServer	对于未直接连接到 Internet 的非 Azure 计算机，请指定非 Azure 计算机可以使用的代理服务器。	ProxyServerProperties
region	计算机元数据的存储位置	string
resourceGroupName	Arc (混合计算) 连接器连接的资源组的名称。	string
servicePrincipal	一个对象，用于访问受 Azure AD 租户保护的资源。	ServicePrincipalProperties

ProxyServerProperties

名称	说明	值
ip	代理服务器 IP	string
port	代理服务器端口	字符串

ServicePrincipalProperties

名称	说明	值
applicationId	服务主体的应用程序 ID。	字符串
secret	应用程序用来证明其身份的机密字符串也可以称为应用程序密码， (只写入) 。	字符串

ARM 模板资源定义

可以使用面向以下操作部署连接器资源类型：

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

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

资源格式

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

{
  "type": "Microsoft.Security/connectors",
  "apiVersion": "2020-01-01-preview",
  "name": "string",
  "properties": {
    "authenticationDetails": {
      "grantedPermissions": [ "string" ],
      "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"

属性值

连接器

名称	说明	Value
type	资源类型	“Microsoft.Security/connectors”
apiVersion	资源 API 版本	“2020-01-01-preview”
name	资源名称	字符串 (必需) 字符限制：1-260 有效字符：字母数字、下划线字符和连字符。
properties	连接器设置数据	ConnectorSettingProperties

ConnectorSettingProperties

名称	说明	值
authenticationDetails	身份验证管理设置，这些设置仅与云连接器相关。	AuthenticationDetailsProperties
hybridComputeSettings	混合计算管理设置。这些设置仅与 Arc autoProvision (混合计算) 相关。	HybridComputeSettingsProperties

AuthenticationDetailsProperties

名称	说明	值
grantedPermissions	在云帐户中检测到的权限。	包含任意项的字符串数组： “AWS：：AWSSecurityHubReadOnlyAccess” “AWS：：AmazonSSMAutomationRole” “AWS：：SecurityAudit” “GCP：：安全中心管理员查看器”
authenticationType	设置对象类型	awsAssumeRole awsCreds gcpCredentials (必需)

AwAssumeRoleAuthenticationDetailsProperties

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

AwsCredsAuthenticationDetailsProperties

名称	说明	值
authenticationType	连接到云帐户，对于 AWS，请使用帐户凭据或基于角色的身份验证。对于 GCP，请使用帐户组织凭据。	“awsCreds” (必需)
awsAccessKeyId	AWS 凭据对象的公钥元素 (只写入)	字符串 (必需)
awsSecretAccessKey	AWS 凭据对象的机密密钥元素 (只写入)	字符串 (必需)

GcpCredentialsDetailsProperties

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

HybridComputeSettingsProperties

名称	说明	值
autoProvision	是否在计算机上安装 Azure Arc (混合计算) 代理	“Off” “On” (必需)
proxyServer	对于未直接连接到 Internet 的非 Azure 计算机，请指定非 Azure 计算机可以使用的代理服务器。	ProxyServerProperties
region	计算机元数据的存储位置	字符串
resourceGroupName	Arc (混合计算) 连接器连接的资源组的名称。	string
servicePrincipal	一个对象，用于访问受 Azure AD 租户保护的资源。	ServicePrincipalProperties

ProxyServerProperties

名称	说明	值
ip	代理服务器 IP	string
port	代理服务器端口	string

ServicePrincipalProperties

名称	说明	值
applicationId	服务主体的应用程序 ID。	字符串
secret	应用程序用来证明其身份的机密字符串也可以称为应用程序密码， (只写入) 。	string

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署连接器资源类型：

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Security/connectors@2020-01-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      authenticationDetails = {
        grantedPermissions = [
          "string"
        ]
        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"

属性值

连接器

名称	说明	Value
type	资源类型	“Microsoft.Security/connectors@2020-01-01-preview”
name	资源名称	字符串 (必需) 字符限制：1-260 有效字符：字母数字、下划线字符和连字符。
parent_id	若要部署到订阅，请使用该订阅的 ID。	字符串 (必需)
properties	连接器设置数据	ConnectorSettingProperties

ConnectorSettingProperties

名称	说明	值
authenticationDetails	身份验证管理设置，这些设置仅与云连接器相关。	AuthenticationDetailsProperties
hybridComputeSettings	混合计算管理设置。这些设置仅与 Arc autoProvision (混合计算) 相关。	HybridComputeSettingsProperties

AuthenticationDetailsProperties

名称	说明	值
grantedPermissions	在云帐户中检测到的权限。	包含任意项的字符串数组： “AWS：：AWSSecurityHubReadOnlyAccess” “AWS：：AmazonSSMAutomationRole” “AWS：：SecurityAudit” “GCP：：安全中心管理员查看器”
authenticationType	设置对象类型	awsAssumeRole awsCreds gcpCredentials (必需)

AwAssumeRoleAuthenticationDetailsProperties

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

AwsCredsAuthenticationDetailsProperties

名称	说明	值
authenticationType	连接到云帐户，对于 AWS，请使用帐户凭据或基于角色的身份验证。对于 GCP，请使用帐户组织凭据。	需要“awsCreds” ()
awsAccessKeyId	AWS 凭据对象的公钥元素 (只写入)	字符串 (必需)
awsSecretAccessKey	AWS 凭据对象的机密密钥元素 (只写入)	字符串 (必需)

GcpCredentialsDetailsProperties

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

HybridComputeSettingsProperties

名称	说明	值
autoProvision	是否在计算机上安装 Azure Arc (混合计算) 代理	"Off" “开” ()
proxyServer	对于未直接连接到 Internet 的非 Azure 计算机，请指定非 Azure 计算机可以使用的代理服务器。	ProxyServerProperties
region	计算机元数据的存储位置	字符串
resourceGroupName	Arc (混合计算) 连接器连接的资源组的名称。	string
servicePrincipal	一个对象，用于访问受 Azure AD 租户保护的资源。	ServicePrincipalProperties

ProxyServerProperties

名称	说明	值
ip	代理服务器 IP	string
port	代理服务器端口	字符串

ServicePrincipalProperties

名称	说明	值
applicationId	服务主体的应用程序 ID。	string
secret	应用程序用来证明其身份的机密字符串也可以称为应用程序密码， (只写入) 。	字符串

Microsoft.Security 连接器

Bicep 资源定义

资源格式

AuthenticationDetailsProperties 对象

属性值

连接器

ConnectorSettingProperties

AuthenticationDetailsProperties

AwAssumeRoleAuthenticationDetailsProperties

AwsCredsAuthenticationDetailsProperties

GcpCredentialsDetailsProperties

HybridComputeSettingsProperties

ProxyServerProperties

ServicePrincipalProperties

ARM 模板资源定义

资源格式

AuthenticationDetailsProperties 对象

属性值

连接器

ConnectorSettingProperties

AuthenticationDetailsProperties

AwAssumeRoleAuthenticationDetailsProperties

AwsCredsAuthenticationDetailsProperties

GcpCredentialsDetailsProperties

HybridComputeSettingsProperties

ProxyServerProperties

ServicePrincipalProperties

Terraform (AzAPI 提供程序) 资源定义

资源格式

AuthenticationDetailsProperties 对象

属性值

连接器

ConnectorSettingProperties

AuthenticationDetailsProperties

AwAssumeRoleAuthenticationDetailsProperties

AwsCredsAuthenticationDetailsProperties

GcpCredentialsDetailsProperties

HybridComputeSettingsProperties

ProxyServerProperties

ServicePrincipalProperties

其他资源