Sdílet prostřednictvím

Konektory Microsoft.Security

  • Článek

Definice prostředku Bicep

Typ prostředku konektorů je možné nasadit s operacemi, které cílí na:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.Security/connectors, přidejte do šablony následující 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 – objekty

Nastavte vlastnost authenticationType tak, aby určila typ objektu.

Pro awsAssumeRole použijte:

  authenticationType: 'awsAssumeRole'
  awsAssumeRoleArn: 'string'
  awsExternalId: 'string'

Pro awsCreds použijte:

  authenticationType: 'awsCreds'
  awsAccessKeyId: 'string'
  awsSecretAccessKey: 'string'

Pro gcpCredentials použijte:

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

Hodnoty vlastností

konektory

Název Description Hodnota
name Název prostředku string (povinné)

Omezení počtu znaků: 1–260

Platné znaky:
Alfanumerické znaky, podtržítka a spojovníky.
properties Data nastavení konektoru ConnectorSettingProperties

ConnectorSettingProperties

Název Description Hodnota
authenticationDetails Nastavení pro správu ověřování– tato nastavení jsou relevantní jenom pro cloudový konektor. AuthenticationDetailsProperties
hybridComputeSettings Nastavení pro správu hybridních výpočetních prostředků Tato nastavení jsou relevantní jenom pro automatické zřízení Arc (Hybrid Compute). HybridComputeSettingsProperties

AuthenticationDetailsProperties

Název Description Hodnota
grantedPermissions Oprávnění zjištěná v cloudovém účtu. Pole řetězců obsahující některou z těchto možností:
AWS::AWSSecurityHubReadOnlyAccess
'AWS::AmazonSSMAutomationRole'
AWS::SecurityAudit
GCP::Security Center Správa Viewer
authenticationType Nastavení typu objektu awsAssumeRole
awsCreds
gcpCredentials (povinné)

AwAssumeRoleAuthenticationDetailsVlastnosti

Název Description Hodnota
authenticationType Připojte se ke svému cloudovému účtu a V případě AWS použijte buď přihlašovací údaje účtu, nebo ověřování na základě role. Pro GCP použijte přihlašovací údaje organizace účtu. 'awsAssumeRole' (povinné)
awsAssumeRoleArn Předpokládá se, že ID role je identifikátor, který můžete použít k vytvoření dočasných přihlašovacích údajů zabezpečení. string (povinné)
awsExternalId Jedinečný identifikátor, který se vyžaduje, když převezmete roli v jiném účtu. string (povinné)

AwsCredsAuthenticationDetailsProperties

Název Description Hodnota
authenticationType Připojte se ke svému cloudovému účtu a V případě AWS použijte buď přihlašovací údaje účtu, nebo ověřování na základě role. Pro GCP použijte přihlašovací údaje organizace účtu. 'awsCreds' (povinné)
awsAccessKeyId Element veřejného klíče objektu přihlašovacích údajů AWS (pouze pro zápis) string (povinné)
awsSecretAccessKey Element tajného klíče objektu přihlašovacích údajů AWS (pouze pro zápis) string (povinné)

GcpCredentialsDetailsVlastnosti

Název Description Hodnota
authenticationType Připojte se ke svému cloudovému účtu a V případě AWS použijte buď přihlašovací údaje účtu, nebo ověřování na základě role. Pro GCP použijte přihlašovací údaje organizace účtu. gcpCredentials (povinné)
authProviderX509CertUrl Pole adresy URL certifikátu zprostředkovatele ověřování x509 klíče rozhraní API (pouze pro zápis) string (povinné)
authUri Pole ověřovacího identifikátoru URI klíče rozhraní API (pouze pro zápis) string (povinné)
clientEmail Pole e-mailu klienta s klíčem rozhraní API (jenom pro zápis) string (povinné)
clientId Pole ID klienta klíče rozhraní API (pouze pro zápis) string (povinné)
clientX509CertUrl Pole adresa URL certifikátu x509 klienta s klíčem rozhraní API (jen pro zápis) string (povinné)
id organizace ID organizace cloudového účtu GCP string (povinné)
privátní klíč Pole Privátní klíč klíče rozhraní API (pouze pro zápis) string (povinné)
id privátního klíče Pole ID privátního klíče klíče rozhraní API (pouze pro zápis) string (povinné)
id projektu Pole ID projektu klíče rozhraní API (pouze pro zápis) string (povinné)
identifikátor tokenu Pole identifikátoru URI tokenu klíče rozhraní API (pouze pro zápis) string (povinné)
typ Pole Type klíče rozhraní API (pouze pro zápis) string (povinné)

HybridComputeSettingsProperties

Název Description Hodnota
automatické zřízení Jestli se mají na počítače automaticky instalovat agenty Azure Arc (hybridní výpočetní prostředky) Vypnuto
Zapnuto (povinné)
proxy server Pro počítač mimo Azure, který není připojený přímo k internetu, zadejte proxy server, který může počítač mimo Azure používat. Vlastnosti proxy serveru
oblast Umístění, kde budou uložena metadata počítačů řetězec
resourceGroupName Název skupiny prostředků, ke které jsou připojené konektory Arc (Hybrid Compute). řetězec
servicePrincipal Objekt pro přístup k prostředkům zabezpečeným Azure AD tenantem. ServicePrincipalProperties

Vlastnosti proxy serveru

Název Description Hodnota
Ip IP adresa proxy serveru řetězec
port Port proxy serveru řetězec

ServicePrincipalProperties

Název Description Hodnota
applicationId ID aplikace instančního objektu řetězec
Tajný kód Tajný řetězec, který aplikace používá k prokázání své identity, může být také označován jako heslo aplikace (pouze pro zápis). řetězec

Definice prostředku šablony ARM

Typ prostředku konektorů je možné nasadit s operacemi, které cílí na:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.Security/connectors, přidejte do šablony následující kód 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"
      }
    }
  }
}

Objekty AuthenticationDetailsProperties

Nastavte vlastnost authenticationType a určete typ objektu.

Pro awsAssumeRole použijte:

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

Pro awsCreds použijte:

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

Pro gcpCredentials použijte:

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

Hodnoty vlastností

konektory

Název Description Hodnota
typ Typ prostředku Microsoft.Security/connectors
apiVersion Verze rozhraní API prostředku 2020-01-01-preview
name Název prostředku string (povinné)

Limit počtu znaků: 1–260

Platné znaky:
Alfanumerické znaky, podtržítka a pomlčky
properties Data nastavení konektoru Nastavení konektoru – vlastnosti

Nastavení konektoru – vlastnosti

Název Description Hodnota
authenticationDetails Nastavení pro správu ověřování– tato nastavení jsou relevantní jenom pro cloudový konektor. AuthenticationDetailsVlastnosti
hybridComputeSettings Nastavení pro správu hybridních výpočetních prostředků. Tato nastavení jsou relevantní pouze pro automatické zřizování Arc (Hybridní výpočetní prostředky). HybridComputeSettingsProperties

AuthenticationDetailsVlastnosti

Název Description Hodnota
grantedPermissions Zjistila se oprávnění v cloudovém účtu. Pole řetězců obsahující některou z těchto možností:
AWS::AWSSecurityHubReadOnlyAccess
'AWS::AmazonSSMAutomationRole'
'AWS::SecurityAudit'
GCP::Security Center Správa Viewer
authenticationType Nastavení typu objektu awsAssumeRole
awsCreds
gcpCredentials (povinné)

AwAssumeRoleAuthenticationDetailsProperties

Název Description Hodnota
authenticationType Připojte se ke svému cloudovému účtu a pro AWS použijte buď přihlašovací údaje účtu, nebo ověřování na základě role. Pro GCP použijte přihlašovací údaje organizace účtu. "awsAssumeRole" (povinné)
awsAssumeRoleArn Předpokládané ID role je identifikátor, který můžete použít k vytvoření dočasných přihlašovacích údajů zabezpečení. string (povinné)
awsExternalId Jedinečný identifikátor, který se vyžaduje, když převezmete roli v jiném účtu. string (povinné)

AwsCredsAuthenticationDetailsVlastnosti

Název Description Hodnota
authenticationType Připojte se ke svému cloudovému účtu a pro AWS použijte buď přihlašovací údaje účtu, nebo ověřování na základě role. Pro GCP použijte přihlašovací údaje organizace účtu. 'awsCreds' (povinné)
awsAccessKeyId Element veřejného klíče objektu přihlašovacích údajů AWS (pouze pro zápis) string (povinné)
awsSecretAccessKey Element tajného klíče objektu přihlašovacích údajů AWS (pouze pro zápis) string (povinné)

GcpCredentialsDetailsVlastnosti

Název Description Hodnota
authenticationType Připojte se ke svému cloudovému účtu a pro AWS použijte buď přihlašovací údaje účtu, nebo ověřování na základě role. Pro GCP použijte přihlašovací údaje organizace účtu. gcpCredentials (povinné)
authProviderX509CertUrl Pole adresa URL certifikátu poskytovatele ověřování x509 klíče rozhraní API (pouze pro zápis) string (povinné)
Identifikátor authUri Pole ověřovacího identifikátoru URI klíče rozhraní API (pouze pro zápis) string (povinné)
clientEmail Pole e-mailu klienta s klíčem rozhraní API (jenom pro zápis) string (povinné)
clientId Pole ID klienta klíče rozhraní API (pouze pro zápis) string (povinné)
clientX509CertUrl Pole adresa URL certifikátu x509 klienta s klíčem rozhraní API (jen pro zápis) string (povinné)
id organizace ID organizace cloudového účtu GCP string (povinné)
privátní klíč Pole Privátní klíč klíče rozhraní API (pouze pro zápis) string (povinné)
id privátního klíče Pole ID privátního klíče klíče rozhraní API (pouze pro zápis) string (povinné)
id projektu Pole ID projektu klíče rozhraní API (pouze pro zápis) string (povinné)
identifikátor tokenu Pole identifikátoru URI tokenu klíče rozhraní API (pouze pro zápis) string (povinné)
typ Pole Type klíče rozhraní API (pouze pro zápis) string (povinné)

HybridComputeSettingsProperties

Název Description Hodnota
automatické zřízení Jestli se mají na počítače automaticky instalovat agenty Azure Arc (hybridní výpočetní prostředky) Vypnuto
Zapnuto (povinné)
proxy server Pro počítač mimo Azure, který není připojený přímo k internetu, zadejte proxy server, který může počítač mimo Azure používat. Vlastnosti proxy serveru
oblast Umístění, kde budou uložena metadata počítačů řetězec
resourceGroupName Název skupiny prostředků, ke které jsou připojené konektory Arc (Hybrid Compute). řetězec
servicePrincipal Objekt pro přístup k prostředkům zabezpečeným Azure AD tenantem. ServicePrincipalProperties

Vlastnosti proxy serveru

Název Description Hodnota
Ip IP adresa proxy serveru řetězec
port Port proxy serveru řetězec

ServicePrincipalProperties

Název Description Hodnota
applicationId ID aplikace instančního objektu řetězec
Tajný kód Tajný řetězec, který aplikace používá k prokázání své identity, může být také označován jako heslo aplikace (pouze pro zápis). řetězec

Definice prostředku Terraform (poskytovatel AzAPI)

Typ prostředku konektorů je možné nasadit s operacemi, které cílí na:

  • Předplatná

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.Security/connectors, přidejte do šablony následující 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"
        }
      }
    }
  })
}

Objekty AuthenticationDetailsProperties

Nastavte vlastnost authenticationType a určete typ objektu.

Pro awsAssumeRole použijte:

  authenticationType = "awsAssumeRole"
  awsAssumeRoleArn = "string"
  awsExternalId = "string"

Pro awsCreds použijte:

  authenticationType = "awsCreds"
  awsAccessKeyId = "string"
  awsSecretAccessKey = "string"

Pro gcpCredentials použijte:

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

Hodnoty vlastností

konektory

Název Description Hodnota
typ Typ prostředku Microsoft.Security/connectors@2020-01-01-preview
name Název prostředku string (povinné)

Limit počtu znaků: 1–260

Platné znaky:
Alfanumerické znaky, podtržítka a pomlčky
parent_id K nasazení do předplatného použijte ID tohoto předplatného. string (povinné)
properties Data nastavení konektoru Nastavení konektoru – vlastnosti

Nastavení konektoru – vlastnosti

Název Description Hodnota
authenticationDetails Nastavení pro správu ověřování– tato nastavení jsou relevantní jenom pro cloudový konektor. AuthenticationDetailsVlastnosti
hybridComputeSettings Nastavení pro správu hybridních výpočetních prostředků. Tato nastavení jsou relevantní pouze pro automatické zřizování Arc (Hybridní výpočetní prostředky). HybridComputeSettingsProperties

AuthenticationDetailsVlastnosti

Název Description Hodnota
grantedPermissions Zjistila se oprávnění v cloudovém účtu. Pole řetězců obsahující některou z těchto možností:
"AWS::AWSSecurityHubReadOnlyAccess"
"AWS::AmazonSSMAutomationRole"
"AWS::SecurityAudit"
GCP::Security Center Správa Viewer
authenticationType Nastavení typu objektu awsAssumeRole
awsCreds
gcpCredentials (povinné)

AwAssumeRoleAuthenticationDetailsProperties

Název Description Hodnota
authenticationType Připojte se ke svému cloudovému účtu a pro AWS použijte buď přihlašovací údaje účtu, nebo ověřování na základě role. Pro GCP použijte přihlašovací údaje organizace účtu. "awsAssumeRole" (povinné)
awsAssumeRoleArn Předpokládá se, že ID role je identifikátor, který můžete použít k vytvoření dočasných přihlašovacích údajů zabezpečení. string (povinné)
awsExternalId Jedinečný identifikátor, který se vyžaduje, když převezmete roli v jiném účtu. string (povinné)

AwsCredsAuthenticationDetailsProperties

Název Description Hodnota
authenticationType Připojte se ke svému cloudovému účtu a V případě AWS použijte buď přihlašovací údaje účtu, nebo ověřování na základě role. Pro GCP použijte přihlašovací údaje organizace účtu. "awsCreds" (povinné)
awsAccessKeyId Element veřejného klíče objektu přihlašovacích údajů AWS (pouze pro zápis) string (povinné)
awsSecretAccessKey Element tajného klíče objektu přihlašovacích údajů AWS (pouze pro zápis) string (povinné)

GcpCredentialsDetailsVlastnosti

Název Description Hodnota
authenticationType Připojte se ke svému cloudovému účtu a V případě AWS použijte buď přihlašovací údaje účtu, nebo ověřování na základě role. Pro GCP použijte přihlašovací údaje organizace účtu. "gcpCredentials" (povinné)
authProviderX509CertUrl Pole adresy URL certifikátu zprostředkovatele ověřování x509 klíče rozhraní API (pouze pro zápis) string (povinné)
authUri Pole ověřovacího identifikátoru URI klíče rozhraní API (pouze pro zápis) string (povinné)
clientEmail Pole e-mailu klienta s klíčem rozhraní API (pouze pro zápis) string (povinné)
clientId Pole ID klienta klíče rozhraní API (pouze pro zápis) string (povinné)
clientX509CertUrl Pole adresy URL certifikátu klienta x509 klíče rozhraní API (pouze pro zápis) string (povinné)
id organizace ID organizace cloudového účtu GCP string (povinné)
privateKey Pole Privátní klíč klíče rozhraní API (pouze pro zápis) string (povinné)
privateKeyId Pole ID privátního klíče klíče rozhraní API (pouze pro zápis) string (povinné)
projectId Pole ID projektu klíče rozhraní API (pouze pro zápis) string (povinné)
tokenUri Pole identifikátoru URI tokenu klíče rozhraní API (pouze pro zápis) string (povinné)
typ Pole Typ klíče rozhraní API (pouze pro zápis) string (povinné)

HybridComputeSettingsProperties

Název Description Hodnota
automatické zřízení Jestli se mají na počítače automaticky instalovat agenty Azure Arc (Hybrid Compute) "Vypnuto"
"Zapnuto" (povinné)
proxyServer Pro počítač mimo Azure, který není připojený přímo k internetu, zadejte proxy server, který může počítač mimo Azure používat. ProxyServerProperties
oblast Umístění, kam se budou ukládat metadata počítačů řetězec
resourceGroupName Název skupiny prostředků, ve které jsou konektory Arc (Hybrid Compute) připojené. řetězec
servicePrincipal Objekt pro přístup k prostředkům zabezpečeným tenantem Azure AD. ServicePrincipalProperties

ProxyServerProperties

Název Description Hodnota
Ip IP adresa proxy serveru řetězec
port Port proxy serveru řetězec

ServicePrincipalProperties

Název Description Hodnota
applicationId ID aplikace instančního objektu. řetězec
Tajný kód Tajný řetězec, který aplikace používá k prokázání identity, může být také označován jako heslo aplikace (pouze pro zápis). řetězec