Dela via


Microsoft.Security-anslutningsappar

Bicep-resursdefinition

Resurstypen anslutningsappar kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Security/connectors-resurs lägger du till följande Bicep i mallen.

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'
      }
    }
  }
}

AuthenticationDetailsEgenskaper-objekt

Ange egenskapen authenticationType för att ange typ av objekt.

För awsAssumeRoleanvänder du:

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

För awsCredsanvänder du:

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

För gcpCredentialsanvänder du:

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

Egenskapsvärden

AuthenticationDetailsEgenskaper

Namn Beskrivning Värde
authenticationType Ange till "awsAssumeRole" för typen AwAssumeRoleAuthenticationDetailsProperties. Ange till "awsCreds" för typen AwsCredsAuthenticationDetailsProperties. Ange till "gcpCredentials" för typen GcpCredentialsDetailsProperties. "awsAssumeRole"
"awsCreds"
"gcpCredentials" (krävs)

AwAssumeRoleAuthenticationDetailsProperties

Namn Beskrivning Värde
authenticationType Anslut till ditt molnkonto, för AWS använder du antingen kontoautentiseringsuppgifter eller rollbaserad autentisering. För GCP använder du autentiseringsuppgifter för kontoorganisationen. "awsAssumeRole" (krävs)
awsAssumeRoleArn Antaget roll-ID är en identifierare som du kan använda för att skapa tillfälliga säkerhetsautentiseringsuppgifter. sträng (krävs)
awsExternalId En unik identifierare som krävs när du övertar en roll i ett annat konto. sträng (krävs)

AwsCredsAuthenticationDetailsProperties

Namn Beskrivning Värde
authenticationType Anslut till ditt molnkonto, för AWS använder du antingen kontoautentiseringsuppgifter eller rollbaserad autentisering. För GCP använder du autentiseringsuppgifter för kontoorganisationen. "awsCreds" (krävs)
awsAccessKeyId Offentligt nyckelelement i AWS-autentiseringsobjektet (endast skrivning) sträng (krävs)
awsSecretAccessKey Hemligt nyckelelement i AWS-autentiseringsobjektet (endast skrivning) sträng (krävs)

ConnectorSettingEgenskaper

Namn Beskrivning Värde
authenticationDetails Inställningar för autentiseringshantering, de här inställningarna är endast relevanta för molnanslutningen. AuthenticationDetailsEgenskaper
hybridComputeSettings Inställningar för hybridbearbetningshantering. De här inställningarna är endast relevanta för Arc autoProvision (Hybrid Compute). HybridComputeSettingsEgenskaper

GcpCredentialsDetailsEgenskaper

Namn Beskrivning Värde
authenticationType Anslut till ditt molnkonto, för AWS använder du antingen kontoautentiseringsuppgifter eller rollbaserad autentisering. För GCP använder du autentiseringsuppgifter för kontoorganisationen. "gcpCredentials" (krävs)
authProviderX509CertUrl Fältet Auth provider x509 certificate URL för API-nyckeln (endast skrivning) sträng (krävs)
authUri Autentiserings-URI-fältet för API-nyckeln (endast skrivning) sträng (krävs)
clientEmail Fältet Klient-e-post för API-nyckeln (endast skrivning) sträng (krävs)
clientId Klient-ID-fältet för API-nyckeln (endast skrivning) sträng (krävs)
clientX509CertUrl Klient x509-certifikat-URL-fältet för API-nyckeln (endast skrivskyddad) sträng (krävs)
organizationId Organisations-ID för GCP-molnkontot sträng (krävs)
privateKey Fältet Privat nyckel i API-nyckeln (endast skrivskyddad) sträng (krävs)
privateKeyId ID-fält för privat nyckel för API-nyckeln (endast skrivning) sträng (krävs)
projectId Projekt-ID-fältet för API-nyckeln (endast skrivning) sträng (krävs)
tokenUri Token-URI-fält för API-nyckeln (endast skrivning) sträng (krävs)
typ Typfält för API-nyckeln (endast skrivning) sträng (krävs)

HybridComputeSettingsEgenskaper

Namn Beskrivning Värde
autoProvision Om azure Arc-agenter (hybridberäkning) ska installeras automatiskt på datorer eller inte "Av"
"På" (krävs)
proxyServer För en icke-Azure-dator som inte är ansluten direkt till Internet anger du en proxyserver som den icke-Azure-datorn kan använda. ProxyServerEgenskaper
region Platsen där metadata för datorer lagras sträng
resourceGroupName Namnet på resursgruppen där Arc-anslutningsappar (Hybrid Compute) är anslutna. sträng
servicePrincipal Ett objekt för åtkomst till resurser som skyddas av en Azure AD-klientorganisation. ServicePrincipalProperties

Microsoft.Security/connectors

Namn Beskrivning Värde
Namn Resursnamnet sträng (krävs)
Egenskaper Inställningsdata för anslutningsprogram ConnectorSettingProperties

ProxyServerEgenskaper

Namn Beskrivning Värde
Ip Proxyserver-IP sträng
hamn Proxyserverport sträng

ServicePrincipalProperties

Namn Beskrivning Värde
applicationId Program-ID för tjänstens huvudnamn. sträng
hemlig En hemlig sträng som programmet använder för att bevisa sin identitet kan även kallas för programlösenord (endast skrivskyddad). sträng

Resursdefinition för ARM-mall

Resurstypen anslutningsappar kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Security/connectors-resurs lägger du till följande JSON i mallen.

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

AuthenticationDetailsEgenskaper-objekt

Ange egenskapen authenticationType för att ange typ av objekt.

För awsAssumeRoleanvänder du:

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

För awsCredsanvänder du:

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

För gcpCredentialsanvänder du:

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

Egenskapsvärden

AuthenticationDetailsEgenskaper

Namn Beskrivning Värde
authenticationType Ange till "awsAssumeRole" för typen AwAssumeRoleAuthenticationDetailsProperties. Ange till "awsCreds" för typen AwsCredsAuthenticationDetailsProperties. Ange till "gcpCredentials" för typen GcpCredentialsDetailsProperties. "awsAssumeRole"
"awsCreds"
"gcpCredentials" (krävs)

AwAssumeRoleAuthenticationDetailsProperties

Namn Beskrivning Värde
authenticationType Anslut till ditt molnkonto, för AWS använder du antingen kontoautentiseringsuppgifter eller rollbaserad autentisering. För GCP använder du autentiseringsuppgifter för kontoorganisationen. "awsAssumeRole" (krävs)
awsAssumeRoleArn Antaget roll-ID är en identifierare som du kan använda för att skapa tillfälliga säkerhetsautentiseringsuppgifter. sträng (krävs)
awsExternalId En unik identifierare som krävs när du övertar en roll i ett annat konto. sträng (krävs)

AwsCredsAuthenticationDetailsProperties

Namn Beskrivning Värde
authenticationType Anslut till ditt molnkonto, för AWS använder du antingen kontoautentiseringsuppgifter eller rollbaserad autentisering. För GCP använder du autentiseringsuppgifter för kontoorganisationen. "awsCreds" (krävs)
awsAccessKeyId Offentligt nyckelelement i AWS-autentiseringsobjektet (endast skrivning) sträng (krävs)
awsSecretAccessKey Hemligt nyckelelement i AWS-autentiseringsobjektet (endast skrivning) sträng (krävs)

ConnectorSettingEgenskaper

Namn Beskrivning Värde
authenticationDetails Inställningar för autentiseringshantering, de här inställningarna är endast relevanta för molnanslutningen. AuthenticationDetailsEgenskaper
hybridComputeSettings Inställningar för hybridbearbetningshantering. De här inställningarna är endast relevanta för Arc autoProvision (Hybrid Compute). HybridComputeSettingsEgenskaper

GcpCredentialsDetailsEgenskaper

Namn Beskrivning Värde
authenticationType Anslut till ditt molnkonto, för AWS använder du antingen kontoautentiseringsuppgifter eller rollbaserad autentisering. För GCP använder du autentiseringsuppgifter för kontoorganisationen. "gcpCredentials" (krävs)
authProviderX509CertUrl Fältet Auth provider x509 certificate URL för API-nyckeln (endast skrivning) sträng (krävs)
authUri Autentiserings-URI-fältet för API-nyckeln (endast skrivning) sträng (krävs)
clientEmail Fältet Klient-e-post för API-nyckeln (endast skrivning) sträng (krävs)
clientId Klient-ID-fältet för API-nyckeln (endast skrivning) sträng (krävs)
clientX509CertUrl Klient x509-certifikat-URL-fältet för API-nyckeln (endast skrivskyddad) sträng (krävs)
organizationId Organisations-ID för GCP-molnkontot sträng (krävs)
privateKey Fältet Privat nyckel i API-nyckeln (endast skrivskyddad) sträng (krävs)
privateKeyId ID-fält för privat nyckel för API-nyckeln (endast skrivning) sträng (krävs)
projectId Projekt-ID-fältet för API-nyckeln (endast skrivning) sträng (krävs)
tokenUri Token-URI-fält för API-nyckeln (endast skrivning) sträng (krävs)
typ Typfält för API-nyckeln (endast skrivning) sträng (krävs)

HybridComputeSettingsEgenskaper

Namn Beskrivning Värde
autoProvision Om azure Arc-agenter (hybridberäkning) ska installeras automatiskt på datorer eller inte "Av"
"På" (krävs)
proxyServer För en icke-Azure-dator som inte är ansluten direkt till Internet anger du en proxyserver som den icke-Azure-datorn kan använda. ProxyServerEgenskaper
region Platsen där metadata för datorer lagras sträng
resourceGroupName Namnet på resursgruppen där Arc-anslutningsappar (Hybrid Compute) är anslutna. sträng
servicePrincipal Ett objekt för åtkomst till resurser som skyddas av en Azure AD-klientorganisation. ServicePrincipalProperties

Microsoft.Security/connectors

Namn Beskrivning Värde
apiVersion API-versionen "2020-01-01-preview"
Namn Resursnamnet sträng (krävs)
Egenskaper Inställningsdata för anslutningsprogram ConnectorSettingProperties
typ Resurstypen "Microsoft.Security/connectors"

ProxyServerEgenskaper

Namn Beskrivning Värde
Ip Proxyserver-IP sträng
hamn Proxyserverport sträng

ServicePrincipalProperties

Namn Beskrivning Värde
applicationId Program-ID för tjänstens huvudnamn. sträng
hemlig En hemlig sträng som programmet använder för att bevisa sin identitet kan även kallas för programlösenord (endast skrivskyddad). sträng

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen anslutningsappar kan distribueras med åtgärder som mål:

  • Prenumeration

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Security/connectors-resurs lägger du till följande Terraform i mallen.

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"
        }
      }
    }
  })
}

AuthenticationDetailsEgenskaper-objekt

Ange egenskapen authenticationType för att ange typ av objekt.

För awsAssumeRoleanvänder du:

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

För awsCredsanvänder du:

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

För gcpCredentialsanvänder du:

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

Egenskapsvärden

AuthenticationDetailsEgenskaper

Namn Beskrivning Värde
authenticationType Ange till "awsAssumeRole" för typen AwAssumeRoleAuthenticationDetailsProperties. Ange till "awsCreds" för typen AwsCredsAuthenticationDetailsProperties. Ange till "gcpCredentials" för typen GcpCredentialsDetailsProperties. "awsAssumeRole"
"awsCreds"
"gcpCredentials" (krävs)

AwAssumeRoleAuthenticationDetailsProperties

Namn Beskrivning Värde
authenticationType Anslut till ditt molnkonto, för AWS använder du antingen kontoautentiseringsuppgifter eller rollbaserad autentisering. För GCP använder du autentiseringsuppgifter för kontoorganisationen. "awsAssumeRole" (krävs)
awsAssumeRoleArn Antaget roll-ID är en identifierare som du kan använda för att skapa tillfälliga säkerhetsautentiseringsuppgifter. sträng (krävs)
awsExternalId En unik identifierare som krävs när du övertar en roll i ett annat konto. sträng (krävs)

AwsCredsAuthenticationDetailsProperties

Namn Beskrivning Värde
authenticationType Anslut till ditt molnkonto, för AWS använder du antingen kontoautentiseringsuppgifter eller rollbaserad autentisering. För GCP använder du autentiseringsuppgifter för kontoorganisationen. "awsCreds" (krävs)
awsAccessKeyId Offentligt nyckelelement i AWS-autentiseringsobjektet (endast skrivning) sträng (krävs)
awsSecretAccessKey Hemligt nyckelelement i AWS-autentiseringsobjektet (endast skrivning) sträng (krävs)

ConnectorSettingEgenskaper

Namn Beskrivning Värde
authenticationDetails Inställningar för autentiseringshantering, de här inställningarna är endast relevanta för molnanslutningen. AuthenticationDetailsEgenskaper
hybridComputeSettings Inställningar för hybridbearbetningshantering. De här inställningarna är endast relevanta för Arc autoProvision (Hybrid Compute). HybridComputeSettingsEgenskaper

GcpCredentialsDetailsEgenskaper

Namn Beskrivning Värde
authenticationType Anslut till ditt molnkonto, för AWS använder du antingen kontoautentiseringsuppgifter eller rollbaserad autentisering. För GCP använder du autentiseringsuppgifter för kontoorganisationen. "gcpCredentials" (krävs)
authProviderX509CertUrl Fältet Auth provider x509 certificate URL för API-nyckeln (endast skrivning) sträng (krävs)
authUri Autentiserings-URI-fältet för API-nyckeln (endast skrivning) sträng (krävs)
clientEmail Fältet Klient-e-post för API-nyckeln (endast skrivning) sträng (krävs)
clientId Klient-ID-fältet för API-nyckeln (endast skrivning) sträng (krävs)
clientX509CertUrl Klient x509-certifikat-URL-fältet för API-nyckeln (endast skrivskyddad) sträng (krävs)
organizationId Organisations-ID för GCP-molnkontot sträng (krävs)
privateKey Fältet Privat nyckel i API-nyckeln (endast skrivskyddad) sträng (krävs)
privateKeyId ID-fält för privat nyckel för API-nyckeln (endast skrivning) sträng (krävs)
projectId Projekt-ID-fältet för API-nyckeln (endast skrivning) sträng (krävs)
tokenUri Token-URI-fält för API-nyckeln (endast skrivning) sträng (krävs)
typ Typfält för API-nyckeln (endast skrivning) sträng (krävs)

HybridComputeSettingsEgenskaper

Namn Beskrivning Värde
autoProvision Om azure Arc-agenter (hybridberäkning) ska installeras automatiskt på datorer eller inte "Av"
"På" (krävs)
proxyServer För en icke-Azure-dator som inte är ansluten direkt till Internet anger du en proxyserver som den icke-Azure-datorn kan använda. ProxyServerEgenskaper
region Platsen där metadata för datorer lagras sträng
resourceGroupName Namnet på resursgruppen där Arc-anslutningsappar (Hybrid Compute) är anslutna. sträng
servicePrincipal Ett objekt för åtkomst till resurser som skyddas av en Azure AD-klientorganisation. ServicePrincipalProperties

Microsoft.Security/connectors

Namn Beskrivning Värde
Namn Resursnamnet sträng (krävs)
Egenskaper Inställningsdata för anslutningsprogram ConnectorSettingProperties
typ Resurstypen "Microsoft.Security/connectors@2020-01-01-preview"

ProxyServerEgenskaper

Namn Beskrivning Värde
Ip Proxyserver-IP sträng
hamn Proxyserverport sträng

ServicePrincipalProperties

Namn Beskrivning Värde
applicationId Program-ID för tjänstens huvudnamn. sträng
hemlig En hemlig sträng som programmet använder för att bevisa sin identitet kan även kallas för programlösenord (endast skrivskyddad). sträng