Microsoft.Security 連接器

• 最新
• 2020-01-01-preview

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	針對 awAssumeRole 類型的類型設定為 'awsAssumeRole'，。 針對 awsCredsAuthenticationDetailsProperties 類型 設定為 'awsCreds'，。 針對 GcpCredentialsDetailsProperties 類型設定為 'gcpCredentials'，。	'awsAssumeRole' 'awsCreds' 'gcpCredentials' （必要）

AwAssumeRoleAuthenticationDetailsProperties

名字	描述	價值
authenticationType	連線到您的雲端帳戶，以便 AWS 使用帳戶認證或角色型驗證。 針對 GCP，請使用帳戶組織認證。	'awsAssumeRole' （必要）
awsAssumeRoleArn	假設的角色標識碼是可用來建立暫時安全性認證的標識碼。	字串 （必要）
awsExternalId	當您在另一個帳戶中擔任角色時所需的唯一標識碼。	字串 （必要）

AwsCredsAuthenticationDetailsProperties

名字	描述	價值
authenticationType	連線到您的雲端帳戶，以便 AWS 使用帳戶認證或角色型驗證。 針對 GCP，請使用帳戶組織認證。	'awsCreds' （必要）
awsAccessKeyId	AWS 認證物件的公鑰元素（僅寫入）	字串 （必要）
awsSecretAccessKey	AWS 認證物件的秘密金鑰元素（僅寫入）	字串 （必要）

ConnectorSettingProperties

名字	描述	價值
authenticationDetails	驗證管理的設定，這些設定僅適用於雲端連接器。	AuthenticationDetailsProperties
hybridComputeSettings	混合式計算管理的設定。 這些設定僅適用於 Arc autoProvision （Hybrid Compute）。	HybridComputeSettingsProperties

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

Microsoft.Security/connectors

名字	描述	價值
名字	資源名稱	字串 （必要）
性能	連接器設定數據	ConnectorSettingProperties

ProxyServerProperties

名字	描述	價值
ip	Proxy 伺服器 IP	字串
港口	Proxy 伺服器埠	字串

ServicePrincipalProperties

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

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	針對 awAssumeRole 類型的類型設定為 'awsAssumeRole'，。 針對 awsCredsAuthenticationDetailsProperties 類型 設定為 'awsCreds'，。 針對 GcpCredentialsDetailsProperties 類型設定為 'gcpCredentials'，。	'awsAssumeRole' 'awsCreds' 'gcpCredentials' （必要）

AwAssumeRoleAuthenticationDetailsProperties

名字	描述	價值
authenticationType	連線到您的雲端帳戶，以便 AWS 使用帳戶認證或角色型驗證。 針對 GCP，請使用帳戶組織認證。	'awsAssumeRole' （必要）
awsAssumeRoleArn	假設的角色標識碼是可用來建立暫時安全性認證的標識碼。	字串 （必要）
awsExternalId	當您在另一個帳戶中擔任角色時所需的唯一標識碼。	字串 （必要）

AwsCredsAuthenticationDetailsProperties

名字	描述	價值
authenticationType	連線到您的雲端帳戶，以便 AWS 使用帳戶認證或角色型驗證。 針對 GCP，請使用帳戶組織認證。	'awsCreds' （必要）
awsAccessKeyId	AWS 認證物件的公鑰元素（僅寫入）	字串 （必要）
awsSecretAccessKey	AWS 認證物件的秘密金鑰元素（僅寫入）	字串 （必要）

ConnectorSettingProperties

名字	描述	價值
authenticationDetails	驗證管理的設定，這些設定僅適用於雲端連接器。	AuthenticationDetailsProperties
hybridComputeSettings	混合式計算管理的設定。 這些設定僅適用於 Arc autoProvision （Hybrid Compute）。	HybridComputeSettingsProperties

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

Microsoft.Security/connectors

名字	描述	價值
apiVersion	API 版本	'2020-01-01-preview'
名字	資源名稱	字串 （必要）
性能	連接器設定數據	ConnectorSettingProperties
類型	資源類型	'Microsoft.Security/connectors'

ProxyServerProperties

名字	描述	價值
ip	Proxy 伺服器 IP	字串
港口	Proxy 伺服器埠	字串

ServicePrincipalProperties

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

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	針對 awAssumeRole 類型的類型設定為 'awsAssumeRole'，。 針對 awsCredsAuthenticationDetailsProperties 類型 設定為 'awsCreds'，。 針對 GcpCredentialsDetailsProperties 類型設定為 'gcpCredentials'，。	'awsAssumeRole' 'awsCreds' 'gcpCredentials' （必要）

AwAssumeRoleAuthenticationDetailsProperties

名字	描述	價值
authenticationType	連線到您的雲端帳戶，以便 AWS 使用帳戶認證或角色型驗證。 針對 GCP，請使用帳戶組織認證。	'awsAssumeRole' （必要）
awsAssumeRoleArn	假設的角色標識碼是可用來建立暫時安全性認證的標識碼。	字串 （必要）
awsExternalId	當您在另一個帳戶中擔任角色時所需的唯一標識碼。	字串 （必要）

AwsCredsAuthenticationDetailsProperties

名字	描述	價值
authenticationType	連線到您的雲端帳戶，以便 AWS 使用帳戶認證或角色型驗證。 針對 GCP，請使用帳戶組織認證。	'awsCreds' （必要）
awsAccessKeyId	AWS 認證物件的公鑰元素（僅寫入）	字串 （必要）
awsSecretAccessKey	AWS 認證物件的秘密金鑰元素（僅寫入）	字串 （必要）

ConnectorSettingProperties

名字	描述	價值
authenticationDetails	驗證管理的設定，這些設定僅適用於雲端連接器。	AuthenticationDetailsProperties
hybridComputeSettings	混合式計算管理的設定。 這些設定僅適用於 Arc autoProvision （Hybrid Compute）。	HybridComputeSettingsProperties

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

Microsoft.Security/connectors

名字	描述	價值
名字	資源名稱	字串 （必要）
性能	連接器設定數據	ConnectorSettingProperties
類型	資源類型	“Microsoft.Security/connectors@2020-01-01-preview”

ProxyServerProperties

名字	描述	價值
ip	Proxy 伺服器 IP	字串
港口	Proxy 伺服器埠	字串

ServicePrincipalProperties

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