Freigeben über


Microsoft.Security Connectors

Bicep-Ressourcendefinition

Der Connectors-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Security/Connectors-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.Security/connectors@2020-01-01-preview' = {
  scope: resourceSymbolicName or scope
  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-Objekte

Legen Sie die authenticationType--Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für awsAssumeRole:

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

Verwenden Sie für awsCreds:

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

Verwenden Sie für 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'
}

Eigenschaftswerte

Microsoft.Security/Connectors

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Connectoreinstellungsdaten ConnectorSettingProperties-
scope Verwenden Sie diese Verwendung beim Erstellen einer Ressource in einem Bereich, der sich von dem Bereitstellungsbereich unterscheidet. Legen Sie diese Eigenschaft auf den symbolischen Namen einer Ressource fest, um die Erweiterungsressourceanzuwenden.

AuthenticationDetailsEigenschaften

Name Beschreibung Wert
Authentifizierungstyp Legen Sie diesen Wert auf "awsAssumeRole" für den Typ "AwAssumeRoleAuthenticationDetailsProperties" fest. Legen Sie diesen Wert auf 'awsCreds' für den Typ AwsCredsAuthenticationDetailsProperties fest. Legen Sie für den Typ GcpCredentialsDetailsPropertiesauf "gcpCredentials" fest. "awsAssumeRole"
"awsCreds"
"gcpCredentials" (erforderlich)

AwAssumeRoleAuthenticationDetailsEigenschaften

Name Beschreibung Wert
Authentifizierungstyp Stellen Sie eine Verbindung mit Ihrem Cloudkonto her, damit AWS entweder Kontoanmeldeinformationen oder rollenbasierte Authentifizierung verwendet. Verwenden Sie für GCP Kontoorganisationsanmeldeinformationen. "awsAssumeRole" (erforderlich)
awsAssumeRoleArn Die angenommene Rollen-ID ist ein Bezeichner, den Sie zum Erstellen temporärer Sicherheitsanmeldeinformationen verwenden können. Zeichenfolge (erforderlich)
awsExternalId Ein eindeutiger Bezeichner, der erforderlich ist, wenn Sie eine Rolle in einem anderen Konto annehmen. Zeichenfolge (erforderlich)

AwsCredsAuthenticationDetailsEigenschaften

Name Beschreibung Wert
Authentifizierungstyp Stellen Sie eine Verbindung mit Ihrem Cloudkonto her, damit AWS entweder Kontoanmeldeinformationen oder rollenbasierte Authentifizierung verwendet. Verwenden Sie für GCP Kontoorganisationsanmeldeinformationen. "awsCreds" (erforderlich)
awsAccessKeyId Öffentliches Schlüsselelement des AWS-Anmeldeinformationsobjekts (schreibgeschützt) Zeichenfolge (erforderlich)
awsSecretAccessKey Geheimes Schlüsselelement des AWS-Anmeldeinformationsobjekts (schreibgeschützt) Zeichenfolge (erforderlich)

ConnectorSettingProperties

Name Beschreibung Wert
AuthentifizierungDetails Einstellungen für die Authentifizierungsverwaltung sind nur für den Cloud Connector relevant. AuthenticationDetailsProperties-
hybridComputeSettings Einstellungen für die Hybridberechnungsverwaltung. Diese Einstellungen sind nur für Arc autoProvision (Hybrid Compute) relevant. HybridComputeSettingsProperties-

GcpCredentialsDetailsEigenschaften

Name Beschreibung Wert
Authentifizierungstyp Stellen Sie eine Verbindung mit Ihrem Cloudkonto her, damit AWS entweder Kontoanmeldeinformationen oder rollenbasierte Authentifizierung verwendet. Verwenden Sie für GCP Kontoorganisationsanmeldeinformationen. "gcpCredentials" (erforderlich)
authProviderX509CertUrl Auth-Anbieter x509 Zertifikat-URL-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
authUri Auth-URI-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
KundenE-Mail Client-E-Mail-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
Kunden-ID Client-ID-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
clientX509CertUrl Client x509-Zertifikat-URL-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
Organisations-ID Die Organisations-ID des GCP-Cloudkontos Zeichenfolge (erforderlich)
privater Schlüssel Private Schlüsselfeld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
privateKeyId Private Schlüssel-ID-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
Projekt-ID Projekt-ID-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
tokenUri Token-URI-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
Art Typfeld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)

HybridComputeSettingsEigenschaften

Name Beschreibung Wert
autoBereitstellen Gibt an, ob Azure Arc(Hybrid Compute)-Agents automatisch auf Computern installiert werden sollen. 'Aus'
"Ein" (erforderlich)
proxyServer Geben Sie für einen Nicht-Azure-Computer, der nicht direkt mit dem Internet verbunden ist, einen Proxyserver an, den der Nicht-Azure-Computer verwenden kann. ProxyServerProperties-
Region Der Speicherort, an dem die Metadaten von Computern gespeichert werden Schnur
Ressourcengruppenname Der Name der Ressourcengruppe, in der Arc(Hybrid Compute)-Connectors verbunden sind. Schnur
servicePrincipal (Dienstprinzipal) Ein Objekt für den Zugriff auf Ressourcen, die durch einen Azure AD-Mandanten gesichert sind. ServicePrincipalProperties

ProxyServer-Eigenschaften

Name Beschreibung Wert
ip Proxyserver-IP Schnur
Hafen Proxyserverport Schnur

ServicePrincipalProperties

Name Beschreibung Wert
Anwendungs-ID Anwendungs-ID des Dienstprinzipals. Schnur
geheim Eine geheime Zeichenfolge, die von der Anwendung verwendet wird, um ihre Identität zu beweisen, kann auch als Anwendungskennwort bezeichnet werden (schreibgeschützt). Schnur

ARM-Vorlagenressourcendefinition

Der Connectors-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Security/Connectors-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden JSON-Code hinzu.

{
  "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-Objekte

Legen Sie die authenticationType--Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für awsAssumeRole:

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

Verwenden Sie für awsCreds:

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

Verwenden Sie für 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"
}

Eigenschaftswerte

Microsoft.Security/Connectors

Name Beschreibung Wert
apiVersion (Englisch) Die API-Version "2020-01-01-preview"
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Connectoreinstellungsdaten ConnectorSettingProperties-
Art Der Ressourcentyp "Microsoft.Security/Connectors"

AuthenticationDetailsEigenschaften

Name Beschreibung Wert
Authentifizierungstyp Legen Sie diesen Wert auf "awsAssumeRole" für den Typ "AwAssumeRoleAuthenticationDetailsProperties" fest. Legen Sie diesen Wert auf 'awsCreds' für den Typ AwsCredsAuthenticationDetailsProperties fest. Legen Sie für den Typ GcpCredentialsDetailsPropertiesauf "gcpCredentials" fest. "awsAssumeRole"
"awsCreds"
"gcpCredentials" (erforderlich)

AwAssumeRoleAuthenticationDetailsEigenschaften

Name Beschreibung Wert
Authentifizierungstyp Stellen Sie eine Verbindung mit Ihrem Cloudkonto her, damit AWS entweder Kontoanmeldeinformationen oder rollenbasierte Authentifizierung verwendet. Verwenden Sie für GCP Kontoorganisationsanmeldeinformationen. "awsAssumeRole" (erforderlich)
awsAssumeRoleArn Die angenommene Rollen-ID ist ein Bezeichner, den Sie zum Erstellen temporärer Sicherheitsanmeldeinformationen verwenden können. Zeichenfolge (erforderlich)
awsExternalId Ein eindeutiger Bezeichner, der erforderlich ist, wenn Sie eine Rolle in einem anderen Konto annehmen. Zeichenfolge (erforderlich)

AwsCredsAuthenticationDetailsEigenschaften

Name Beschreibung Wert
Authentifizierungstyp Stellen Sie eine Verbindung mit Ihrem Cloudkonto her, damit AWS entweder Kontoanmeldeinformationen oder rollenbasierte Authentifizierung verwendet. Verwenden Sie für GCP Kontoorganisationsanmeldeinformationen. "awsCreds" (erforderlich)
awsAccessKeyId Öffentliches Schlüsselelement des AWS-Anmeldeinformationsobjekts (schreibgeschützt) Zeichenfolge (erforderlich)
awsSecretAccessKey Geheimes Schlüsselelement des AWS-Anmeldeinformationsobjekts (schreibgeschützt) Zeichenfolge (erforderlich)

ConnectorSettingProperties

Name Beschreibung Wert
AuthentifizierungDetails Einstellungen für die Authentifizierungsverwaltung sind nur für den Cloud Connector relevant. AuthenticationDetailsProperties-
hybridComputeSettings Einstellungen für die Hybridberechnungsverwaltung. Diese Einstellungen sind nur für Arc autoProvision (Hybrid Compute) relevant. HybridComputeSettingsProperties-

GcpCredentialsDetailsEigenschaften

Name Beschreibung Wert
Authentifizierungstyp Stellen Sie eine Verbindung mit Ihrem Cloudkonto her, damit AWS entweder Kontoanmeldeinformationen oder rollenbasierte Authentifizierung verwendet. Verwenden Sie für GCP Kontoorganisationsanmeldeinformationen. "gcpCredentials" (erforderlich)
authProviderX509CertUrl Auth-Anbieter x509 Zertifikat-URL-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
authUri Auth-URI-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
KundenE-Mail Client-E-Mail-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
Kunden-ID Client-ID-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
clientX509CertUrl Client x509-Zertifikat-URL-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
Organisations-ID Die Organisations-ID des GCP-Cloudkontos Zeichenfolge (erforderlich)
privater Schlüssel Private Schlüsselfeld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
privateKeyId Private Schlüssel-ID-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
Projekt-ID Projekt-ID-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
tokenUri Token-URI-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
Art Typfeld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)

HybridComputeSettingsEigenschaften

Name Beschreibung Wert
autoBereitstellen Gibt an, ob Azure Arc(Hybrid Compute)-Agents automatisch auf Computern installiert werden sollen. 'Aus'
"Ein" (erforderlich)
proxyServer Geben Sie für einen Nicht-Azure-Computer, der nicht direkt mit dem Internet verbunden ist, einen Proxyserver an, den der Nicht-Azure-Computer verwenden kann. ProxyServerProperties-
Region Der Speicherort, an dem die Metadaten von Computern gespeichert werden Schnur
Ressourcengruppenname Der Name der Ressourcengruppe, in der Arc(Hybrid Compute)-Connectors verbunden sind. Schnur
servicePrincipal (Dienstprinzipal) Ein Objekt für den Zugriff auf Ressourcen, die durch einen Azure AD-Mandanten gesichert sind. ServicePrincipalProperties

ProxyServer-Eigenschaften

Name Beschreibung Wert
ip Proxyserver-IP Schnur
Hafen Proxyserverport Schnur

ServicePrincipalProperties

Name Beschreibung Wert
Anwendungs-ID Anwendungs-ID des Dienstprinzipals. Schnur
geheim Eine geheime Zeichenfolge, die von der Anwendung verwendet wird, um ihre Identität zu beweisen, kann auch als Anwendungskennwort bezeichnet werden (schreibgeschützt). Schnur

Verwendungsbeispiele

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Connectors-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Security/Connectors-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Security/connectors@2020-01-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    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-Objekte

Legen Sie die authenticationType--Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für awsAssumeRole:

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

Verwenden Sie für awsCreds:

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

Verwenden Sie für 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"
}

Eigenschaftswerte

Microsoft.Security/Connectors

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, auf die diese Erweiterungsressource angewendet werden soll. Zeichenfolge (erforderlich)
Eigenschaften Connectoreinstellungsdaten ConnectorSettingProperties-
Art Der Ressourcentyp "Microsoft.Security/connectors@2020-01-01-preview"

AuthenticationDetailsEigenschaften

Name Beschreibung Wert
Authentifizierungstyp Legen Sie diesen Wert auf "awsAssumeRole" für den Typ "AwAssumeRoleAuthenticationDetailsProperties" fest. Legen Sie diesen Wert auf 'awsCreds' für den Typ AwsCredsAuthenticationDetailsProperties fest. Legen Sie für den Typ GcpCredentialsDetailsPropertiesauf "gcpCredentials" fest. "awsAssumeRole"
"awsCreds"
"gcpCredentials" (erforderlich)

AwAssumeRoleAuthenticationDetailsEigenschaften

Name Beschreibung Wert
Authentifizierungstyp Stellen Sie eine Verbindung mit Ihrem Cloudkonto her, damit AWS entweder Kontoanmeldeinformationen oder rollenbasierte Authentifizierung verwendet. Verwenden Sie für GCP Kontoorganisationsanmeldeinformationen. "awsAssumeRole" (erforderlich)
awsAssumeRoleArn Die angenommene Rollen-ID ist ein Bezeichner, den Sie zum Erstellen temporärer Sicherheitsanmeldeinformationen verwenden können. Zeichenfolge (erforderlich)
awsExternalId Ein eindeutiger Bezeichner, der erforderlich ist, wenn Sie eine Rolle in einem anderen Konto annehmen. Zeichenfolge (erforderlich)

AwsCredsAuthenticationDetailsEigenschaften

Name Beschreibung Wert
Authentifizierungstyp Stellen Sie eine Verbindung mit Ihrem Cloudkonto her, damit AWS entweder Kontoanmeldeinformationen oder rollenbasierte Authentifizierung verwendet. Verwenden Sie für GCP Kontoorganisationsanmeldeinformationen. "awsCreds" (erforderlich)
awsAccessKeyId Öffentliches Schlüsselelement des AWS-Anmeldeinformationsobjekts (schreibgeschützt) Zeichenfolge (erforderlich)
awsSecretAccessKey Geheimes Schlüsselelement des AWS-Anmeldeinformationsobjekts (schreibgeschützt) Zeichenfolge (erforderlich)

ConnectorSettingProperties

Name Beschreibung Wert
AuthentifizierungDetails Einstellungen für die Authentifizierungsverwaltung sind nur für den Cloud Connector relevant. AuthenticationDetailsProperties-
hybridComputeSettings Einstellungen für die Hybridberechnungsverwaltung. Diese Einstellungen sind nur für Arc autoProvision (Hybrid Compute) relevant. HybridComputeSettingsProperties-

GcpCredentialsDetailsEigenschaften

Name Beschreibung Wert
Authentifizierungstyp Stellen Sie eine Verbindung mit Ihrem Cloudkonto her, damit AWS entweder Kontoanmeldeinformationen oder rollenbasierte Authentifizierung verwendet. Verwenden Sie für GCP Kontoorganisationsanmeldeinformationen. "gcpCredentials" (erforderlich)
authProviderX509CertUrl Auth-Anbieter x509 Zertifikat-URL-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
authUri Auth-URI-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
KundenE-Mail Client-E-Mail-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
Kunden-ID Client-ID-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
clientX509CertUrl Client x509-Zertifikat-URL-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
Organisations-ID Die Organisations-ID des GCP-Cloudkontos Zeichenfolge (erforderlich)
privater Schlüssel Private Schlüsselfeld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
privateKeyId Private Schlüssel-ID-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
Projekt-ID Projekt-ID-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
tokenUri Token-URI-Feld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)
Art Typfeld des API-Schlüssels (schreibgeschützt) Zeichenfolge (erforderlich)

HybridComputeSettingsEigenschaften

Name Beschreibung Wert
autoBereitstellen Gibt an, ob Azure Arc(Hybrid Compute)-Agents automatisch auf Computern installiert werden sollen. 'Aus'
"Ein" (erforderlich)
proxyServer Geben Sie für einen Nicht-Azure-Computer, der nicht direkt mit dem Internet verbunden ist, einen Proxyserver an, den der Nicht-Azure-Computer verwenden kann. ProxyServerProperties-
Region Der Speicherort, an dem die Metadaten von Computern gespeichert werden Schnur
Ressourcengruppenname Der Name der Ressourcengruppe, in der Arc(Hybrid Compute)-Connectors verbunden sind. Schnur
servicePrincipal (Dienstprinzipal) Ein Objekt für den Zugriff auf Ressourcen, die durch einen Azure AD-Mandanten gesichert sind. ServicePrincipalProperties

ProxyServer-Eigenschaften

Name Beschreibung Wert
ip Proxyserver-IP Schnur
Hafen Proxyserverport Schnur

ServicePrincipalProperties

Name Beschreibung Wert
Anwendungs-ID Anwendungs-ID des Dienstprinzipals. Schnur
geheim Eine geheime Zeichenfolge, die von der Anwendung verwendet wird, um ihre Identität zu beweisen, kann auch als Anwendungskennwort bezeichnet werden (schreibgeschützt). Schnur