共用方式為

Microsoft.Security 連接器

  • 發行項

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 (Hybrid Compute) 。 HybridComputeSettingsProperties

AuthenticationDetailsProperties

名稱 描述 值
grantedPermissions 在雲端帳戶中偵測到的許可權。 包含任何項目的字串數組：
'AWS：：AWSSecurityHubReadOnlyAccess'
'AWS：：AmazonSSMAutomationRole'
'AWS：：SecurityAudit'
'GCP：：資訊安全中心 管理員 查看器'
authenticationType 設定物件類型 awsAssumeRole
awsCreds
gcpCredentials (必要)

AwAssumeRoleAuthenticationDetailsProperties

名稱 描述 值
authenticationType 連線到您的雲端帳戶，以供 AWS 使用帳戶認證或角色型驗證。 針對 GCP，請使用帳戶組織認證。 'awsAssumeRole' (必要)
awsAssumeRoleArn 假設的角色標識碼是可用來建立暫時安全性認證的標識碼。 字串 (必要)
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 金鑰的用戶端識別符字段， (只寫入) 字串 (必要)
clientX509CertUrl API 金鑰的用戶端 x509 憑證 URL 欄位， (只寫入) 字串 (必要)
organizationId GCP 雲端帳戶的組織標識碼 字串 (必要)
privateKey API 金鑰的私鑰欄位 (只寫入) 字串 (必要)
privateKeyId API 金鑰的私鑰標識碼字段 (只寫入) 字串 (必要)
projectId API 金鑰的項目識別元字段 (只寫入) 字串 (必要)
tokenUri API 金鑰的令牌 URI 字段 (只寫入) 字串 (必要)
類型 API 金鑰的類型欄位， (只寫入) 字串 (必要)

HybridComputeSettingsProperties

名稱 描述 值
autoProvision 是否要在機器上自動安裝 Azure Arc (混合式計算) 代理程式 'Off'
'On' (必要)
proxyServer 針對未直接連線到因特網的非 Azure 計算機，請指定非 Azure 機器可以使用的 Proxy 伺服器。 ProxyServerProperties
區域 將儲存機器元數據的位置 字串
resourceGroupName 線上 Arc (混合式計算) 連接器的資源群組名稱。 字串
servicePrincipal 用來存取受 Azure AD 租用戶保護之資源的物件。 ServicePrincipalProperties

ProxyServerProperties

名稱 描述 值
ip Proxy 伺服器 IP string
連接埠 Proxy 伺服器連接埠 字串

ServicePrincipalProperties

名稱 描述 值
applicationId 服務主體的應用程式識別碼。 字串
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"

屬性值

連接器

名稱 描述 值
類型 資源類型 'Microsoft.Security/connectors'
apiVersion 資源 API 版本 '2020-01-01-preview'
NAME 資源名稱 字串 (必要)

字元限制：1-260

合法字元：
英數字元、底線和連字號。
properties 連接器設定數據 ConnectorSettingProperties

ConnectorSettingProperties

名稱 描述 值
authenticationDetails 驗證管理的設定，這些設定僅與雲端連接器相關。 AuthenticationDetailsProperties
hybridComputeSettings 混合式計算管理的設定。 這些設定僅適用於 Arc autoProvision (Hybrid Compute) 。 HybridComputeSettingsProperties

AuthenticationDetailsProperties

名稱 描述 值
grantedPermissions 在雲端帳戶中偵測到的許可權。 包含任何項目的字串數組：
'AWS：：AWSSecurityHubReadOnlyAccess'
'AWS：：AmazonSSMAutomationRole'
'AWS：：SecurityAudit'
'GCP：：Security Center 管理員 Viewer'
authenticationType 設定物件類型 awsAssumeRole
awsCreds
gcpCredentials (必要)

AwAssumeRoleAuthenticationDetailsProperties

名稱 描述 值
authenticationType 連線到您的雲端帳戶，以供 AWS 使用帳戶認證或角色型驗證。 針對 GCP，請使用帳戶組織認證。 'awsAssumeRole' (必要)
awsAssumeRoleArn 假設的角色標識碼是可用來建立暫時安全性認證的標識碼。 需要字串 ()
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 金鑰的用戶端識別碼字段 (僅寫入) 需要字串 ()
clientX509CertUrl API 金鑰的 [用戶端 x509 憑證 URL] 字段， (只寫入) 需要字串 ()
organizationId GCP 雲端帳戶的組織標識碼 需要字串 ()
privateKey API 金鑰的私鑰欄位 (只寫入) 需要字串 ()
privateKeyId API 金鑰的私鑰標識符字段 (僅寫入) 需要字串 ()
projectId API 金鑰的項目識別元字段 (只寫入) 需要字串 ()
tokenUri API 金鑰的令牌 URI 字段 (僅寫入) 需要字串 ()
類型 API 金鑰的類型字段 (只寫入) 需要字串 ()

HybridComputeSettingsProperties

名稱 描述 值
autoProvision 是否要在機器上自動安裝 Azure Arc (混合式計算) 代理程式 'Off'
需要 『On』 ()
proxyServer 對於未直接連線到因特網的非 Azure 計算機，請指定非 Azure 機器可以使用的 Proxy 伺服器。 ProxyServerProperties
區域 將儲存機器元數據的位置 字串
resourceGroupName 連接 Arc (Hybrid Compute) 連接器的資源組名。 字串
servicePrincipal 對象，用來存取受 Azure AD 租使用者保護的資源。 ServicePrincipalProperties

ProxyServerProperties

名稱 描述 值
ip Proxy 伺服器 IP string
連接埠 Proxy 伺服器連接埠 字串

ServicePrincipalProperties

名稱 描述 值
applicationId 服務主體的應用程式識別碼。 字串
secret 應用程式用來證明其身分識別的秘密字串，也可以稱為應用程式密碼 (只寫入) 。 字串

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"

屬性值

連接器

名稱 描述 值
類型 資源類型 “Microsoft.Security/connectors@2020-01-01-preview”
NAME 資源名稱 需要字串 ()

字元限制：1-260

合法字元：
英數字元、底線和連字號。
parent_id 若要部署至訂用帳戶，請使用該訂用帳戶的標識碼。 需要字串 ()
properties 連接器設定數據 ConnectorSettingProperties

ConnectorSettingProperties

名稱 描述 值
authenticationDetails 驗證管理的設定，這些設定僅與雲端連接器相關。 AuthenticationDetailsProperties
hybridComputeSettings 混合式計算管理的設定。 這些設定僅適用於 Arc autoProvision (Hybrid Compute) 。 HybridComputeSettingsProperties

AuthenticationDetailsProperties

名稱 描述 值
grantedPermissions 在雲端帳戶中偵測到的許可權。 包含任何項目的字串數組：
“AWS：：AWSSecurityHubReadOnlyAccess”
“AWS：：AmazonSSMAutomationRole”
“AWS：：SecurityAudit”
“GCP：：Security Center 管理員 Viewer”
authenticationType 設定物件類型 awsAssumeRole
awsCreds
gcpCredentials (必要)

AwAssumeRoleAuthenticationDetailsProperties

名稱 描述 值
authenticationType 連線到您的雲端帳戶，以供 AWS 使用帳戶認證或角色型驗證。 針對 GCP，請使用帳戶組織認證。 “awsAssumeRole” (必要)
awsAssumeRoleArn 假設的角色標識碼是可用來建立暫時安全性認證的標識碼。 需要字串 ()
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 金鑰的用戶端識別碼字段 (僅寫入) 需要字串 ()
clientX509CertUrl API 金鑰的 [用戶端 x509 憑證 URL] 字段， (只寫入) 需要字串 ()
organizationId GCP 雲端帳戶的組織標識碼 需要字串 ()
privateKey API 金鑰的私鑰欄位 (只寫入) 需要字串 ()
privateKeyId API 金鑰的私鑰標識符字段 (僅寫入) 需要字串 ()
projectId API 金鑰的項目識別元字段 (只寫入) 需要字串 ()
tokenUri API 金鑰的令牌 URI 字段 (僅寫入) 需要字串 ()
類型 API 金鑰的類型字段 (只寫入) 需要字串 ()

HybridComputeSettingsProperties

名稱 描述 值
autoProvision 是否要在機器上自動安裝 Azure Arc (混合式計算) 代理程式 “Off”
“On” (必要)
proxyServer 對於未直接連線到因特網的非 Azure 計算機，請指定非 Azure 機器可以使用的 Proxy 伺服器。 ProxyServerProperties
區域 將儲存機器元數據的位置 字串
resourceGroupName 連接 Arc (Hybrid Compute) 連接器的資源組名。 字串
servicePrincipal 對象，用來存取受 Azure AD 租使用者保護的資源。 ServicePrincipalProperties

ProxyServerProperties

名稱 描述 值
ip Proxy 伺服器 IP string
連接埠 Proxy 伺服器連接埠 字串

ServicePrincipalProperties

名稱 描述 值
applicationId 服務主體的應用程式識別碼。 字串
secret 應用程式用來證明其身分識別的秘密字串，也可以稱為應用程式密碼 (只寫入) 。 字串