Microsoft.Security-anslutningsappar
Bicep-resursdefinition
Resurstypen anslutningsappar kan distribueras med åtgärder som mål:
- Prenumerationer – Se distributionskommandon för prenumerationer
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: {
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'
}
}
}
}
AuthenticationDetailsEgenskaper-objekt
Ange egenskapen authenticationType för att ange typ av objekt.
För awsAssumeRole använder du:
authenticationType: 'awsAssumeRole'
awsAssumeRoleArn: 'string'
awsExternalId: 'string'
För awsCreds använder du:
authenticationType: 'awsCreds'
awsAccessKeyId: 'string'
awsSecretAccessKey: 'string'
För gcpCredentials anvä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
anslutningar
| Name | Beskrivning | Värde |
|---|---|---|
| name | Resursnamnet | sträng (krävs) Teckengräns: 1–260 Giltiga tecken: Alfanumeriska tecken, understreck och bindestreck. |
| properties | Inställningsdata för anslutningsprogram | ConnectorSettingEgenskaper |
ConnectorSettingEgenskaper
| Name | Beskrivning | Värde |
|---|---|---|
| authenticationDetails | Inställningar för autentiseringshantering, de här inställningarna är endast relevanta för molnanslutningsappen. | AuthenticationDetailsEgenskaper |
| hybridComputeSettings | Inställningar för hybridberäkningshantering. De här inställningarna är endast relevanta för Arc autoProvision (Hybrid Compute). | HybridComputeSettingsEgenskaper |
AuthenticationDetailsEgenskaper
| Name | Beskrivning | Värde |
|---|---|---|
| grantedPermissions | De behörigheter som identifieras i molnkontot. | Strängmatris som innehåller något av: "AWS::AWSSecurityHubReadOnlyAccess" "AWS::AmazonSSMAutomationRole" "AWS::SecurityAudit" 'GCP::Security Center Admin Viewer' |
| authenticationType | Ange objekttyp | awsAssumeRole awsCreds gcpCredentials (krävs) |
AwAssumeRoleAuthenticationDetailsProperties
| Name | 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 kontoorganisation. | "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 antar en roll i ett annat konto. | sträng (krävs) |
AwsCredsAuthenticationDetailsEgenskaper
| Name | 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 kontoorganisation. | "awsCreds" (krävs) |
| awsAccessKeyId | Offentligt nyckelelement i AWS-autentiseringsobjektet (skrivskyddad) | sträng (krävs) |
| awsSecretAccessKey | Hemligt nyckelelement i AWS-autentiseringsobjektet (skrivskyddad) | sträng (krävs) |
GcpCredentialsDetailsEgenskaper
| Name | 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 kontoorganisation. | "gcpCredentials" (krävs) |
| authProviderX509CertUrl | Fältet Auth provider x509 certificate URL för API-nyckeln (endast skrivskyddad) | sträng (krävs) |
| authUri | Autentiserings-URI-fält för API-nyckeln (endast skrivskyddad) | 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 | Url-fältet för klientens x509-certifikat för API-nyckeln (endast skrivning) | sträng (krävs) |
| organizationId | Organisations-ID för GCP-molnkontot | sträng (krävs) |
| privateKey | Fältet Privat nyckel för API-nyckeln (endast skrivning) | sträng (krävs) |
| privateKeyId | Fältet Privat nyckel-ID 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) |
HybridComputeSettingsProperties
| Name | Beskrivning | Värde |
|---|---|---|
| autoProvision | Om Azure Arc-agenter (hybridberäkning) ska installeras automatiskt på datorer eller inte | "Av" "På" (obligatoriskt) |
| 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 att komma åt resurser som skyddas av en Azure AD klientorganisation. | ServicePrincipalProperties |
ProxyServerEgenskaper
| Name | Beskrivning | Värde |
|---|---|---|
| Ip | Proxyserver-IP | sträng |
| port | Proxyserverport | sträng |
ServicePrincipalProperties
| Name | Beskrivning | Värde |
|---|---|---|
| applicationId | Program-ID för tjänstens huvudnamn. | sträng |
| hemlighet | En hemlig sträng som programmet använder för att bevisa sin identitet kan även kallas programlösenord (endast skrivning). | sträng |
Resursdefinition för ARM-mall
Anslutningsappens resurstyp kan distribueras med åtgärder som mål:
- Prenumerationer – Se kommandon för prenumerationsdistribution
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en resurs för Microsoft.Security/connectors lägger du till följande JSON i mallen.
{
"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"
}
}
}
}
AuthenticationDetailsEgenskaper-objekt
Ange egenskapen authenticationType för att ange objekttypen.
För awsAssumeRole använder du:
"authenticationType": "awsAssumeRole",
"awsAssumeRoleArn": "string",
"awsExternalId": "string"
För awsCreds använder du:
"authenticationType": "awsCreds",
"awsAccessKeyId": "string",
"awsSecretAccessKey": "string"
För gcpCredentials anvä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
anslutningar
| Name | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.Security/connectors" |
| apiVersion | Resurs-API-versionen | "2020-01-01-preview" |
| name | Resursnamnet | sträng (krävs) Teckengräns: 1–260 Giltiga tecken: Alfanumeriska tecken, understreck och bindestreck. |
| properties | Inställningsdata för anslutningsprogram | ConnectorSettingProperties |
ConnectorSettingProperties
| Name | Beskrivning | Värde |
|---|---|---|
| authenticationDetails | Inställningar för autentiseringshantering, de här inställningarna är endast relevanta för molnanslutningsappen. | AuthenticationDetailsEgenskaper |
| hybridComputeSettings | Inställningar för hybridberäkningshantering. De här inställningarna är endast relevanta för Arc autoProvision (Hybrid Compute). | HybridComputeSettingsEgenskaper |
AuthenticationDetailsEgenskaper
| Name | Beskrivning | Värde |
|---|---|---|
| grantedPermissions | De behörigheter som identifieras i molnkontot. | Strängmatris som innehåller något av: "AWS::AWSSecurityHubReadOnlyAccess" "AWS::AmazonSSMAutomationRole" "AWS::SecurityAudit" 'GCP::Security Center Admin Viewer' |
| authenticationType | Ange objekttyp | awsAssumeRole awsCreds gcpCredentials (krävs) |
AwAssumeRoleAuthenticationDetailsProperties
| Name | 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 kontoorganisation. | "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 antar en roll i ett annat konto. | sträng (krävs) |
AwsCredsAuthenticationDetailsEgenskaper
| Name | 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 kontoorganisation. | "awsCreds" (krävs) |
| awsAccessKeyId | Offentligt nyckelelement i AWS-autentiseringsobjektet (skrivskyddad) | sträng (krävs) |
| awsSecretAccessKey | Hemligt nyckelelement i AWS-autentiseringsobjektet (skrivskyddad) | sträng (krävs) |
GcpCredentialsDetailsEgenskaper
| Name | 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 kontoorganisation. | "gcpCredentials" (krävs) |
| authProviderX509CertUrl | Fältet Auth provider x509 certificate URL för API-nyckeln (endast skrivskyddad) | sträng (krävs) |
| authUri | Autentiserings-URI-fält för API-nyckeln (endast skrivskyddad) | sträng (krävs) |
| clientEmail | Fältet Klient-e-post för API-nyckeln (skrivskyddad) | sträng (krävs) |
| ClientID | Klient-ID-fältet för API-nyckeln (endast skrivning) | sträng (krävs) |
| clientX509CertUrl | Fältet Klient-x509-certifikat-URL för API-nyckeln (skrivskyddad) | sträng (krävs) |
| organizationId | Organisations-ID för GCP-molnkontot | sträng (krävs) |
| privateKey | Fältet Privat nyckel för API-nyckeln (skrivskyddad) | sträng (krävs) |
| privateKeyId | Fältet Privat nyckel-ID för API-nyckeln (skrivskyddad) | sträng (krävs) |
| projectId | Projekt-ID-fältet för API-nyckeln (skrivskyddad) | 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 (skrivskyddad) | sträng (krävs) |
HybridComputeSettingsEgenskaper
| Name | Beskrivning | Värde |
|---|---|---|
| autoProvision | Om Azure Arc-agenter (hybridberäkning) ska installeras automatiskt på datorer eller inte | "Av" "På" (obligatoriskt) |
| 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 att komma åt resurser som skyddas av en Azure AD klientorganisation. | ServicePrincipalProperties |
ProxyServerEgenskaper
| Name | Beskrivning | Värde |
|---|---|---|
| Ip | Proxyserver-IP | sträng |
| port | Proxyserverport | sträng |
ServicePrincipalProperties
| Name | Beskrivning | Värde |
|---|---|---|
| applicationId | Program-ID för tjänstens huvudnamn. | sträng |
| hemlighet | En hemlig sträng som programmet använder för att bevisa sin identitet kan även kallas programlösenord (endast skrivning). | sträng |
Resursdefinition för Terraform (AzAPI-provider)
Anslutningsappens resurstyp kan distribueras med åtgärder som mål:
- Prenumerationer
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en resurs för Microsoft.Security/connectors lägger du till följande Terraform i mallen.
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"
}
}
}
})
}
AuthenticationDetailsEgenskaper-objekt
Ange egenskapen authenticationType för att ange objekttypen.
För awsAssumeRole använder du:
authenticationType = "awsAssumeRole"
awsAssumeRoleArn = "string"
awsExternalId = "string"
För awsCreds använder du:
authenticationType = "awsCreds"
awsAccessKeyId = "string"
awsSecretAccessKey = "string"
För gcpCredentials anvä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
anslutningar
| Name | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.Security/connectors@2020-01-01-preview" |
| name | Resursnamnet | sträng (krävs) Teckengräns: 1–260 Giltiga tecken: Alfanumeriska tecken, understreck och bindestreck. |
| parent_id | Om du vill distribuera till en prenumeration använder du ID:t för den prenumerationen. | sträng (krävs) |
| properties | Inställningsdata för anslutningsprogram | ConnectorSettingProperties |
ConnectorSettingProperties
| Name | Beskrivning | Värde |
|---|---|---|
| authenticationDetails | Inställningar för autentiseringshantering. Dessa inställningar är endast relevanta för molnanslutningsappen. | AuthenticationDetailsEgenskaper |
| hybridComputeSettings | Inställningar för hybridberäkningshantering. De här inställningarna är endast relevanta för Arc autoProvision (Hybrid Compute). | HybridComputeSettingsProperties |
AuthenticationDetailsEgenskaper
| Name | Beskrivning | Värde |
|---|---|---|
| grantedPermissions | De behörigheter som identifieras i molnkontot. | Strängmatris som innehåller något av: "AWS::AWSSecurityHubReadOnlyAccess" "AWS::AmazonSSMAutomationrole" "AWS::SecurityAudit" "GCP::Security Center Admin Viewer" |
| authenticationType | Ange objekttyp | awsAssumeRole awsCreds gcpCredentials (krävs) |
AwAssumeRoleAuthenticationDetailsProperties
| Name | 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 kontoorganisation. | "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 antar en roll i ett annat konto. | sträng (krävs) |
AwsCredsAuthenticationDetailsEgenskaper
| Name | 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 kontoorganisation. | "awsCreds" (krävs) |
| awsAccessKeyId | Offentligt nyckelelement i AWS-autentiseringsobjektet (skrivskyddad) | sträng (krävs) |
| awsSecretAccessKey | Hemligt nyckelelement i AWS-autentiseringsobjektet (skrivskyddad) | sträng (krävs) |
GcpCredentialsDetailsEgenskaper
| Name | 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 kontoorganisation. | "gcpCredentials" (krävs) |
| authProviderX509CertUrl | Fältet Auth provider x509 certificate URL för API-nyckeln (endast skrivskyddad) | sträng (krävs) |
| authUri | Autentiserings-URI-fält för API-nyckeln (endast skrivskyddad) | sträng (krävs) |
| clientEmail | Fältet Klient-e-post för API-nyckeln (skrivskyddad) | sträng (krävs) |
| ClientID | Klient-ID-fältet för API-nyckeln (endast skrivning) | sträng (krävs) |
| clientX509CertUrl | Fältet Klient-x509-certifikat-URL för API-nyckeln (skrivskyddad) | sträng (krävs) |
| organizationId | Organisations-ID för GCP-molnkontot | sträng (krävs) |
| privateKey | Fältet Privat nyckel för API-nyckeln (skrivskyddad) | sträng (krävs) |
| privateKeyId | Fältet Privat nyckel-ID för API-nyckeln (skrivskyddad) | sträng (krävs) |
| projectId | Projekt-ID-fältet för API-nyckeln (skrivskyddad) | 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 (skrivskyddad) | sträng (krävs) |
HybridComputeSettingsEgenskaper
| Name | 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 |
ProxyServerEgenskaper
| Name | Beskrivning | Värde |
|---|---|---|
| Ip | Proxyserver-IP | sträng |
| port | Proxyserverport | sträng |
ServicePrincipalProperties
| Name | Beskrivning | Värde |
|---|---|---|
| applicationId | Program-ID för tjänstens huvudnamn. | sträng |
| hemlighet | En hemlig sträng som programmet använder för att bevisa sin identitet, kan även kallas programlösenord (skriv endast). | sträng |
Feedback
Kommer snart: Under hela 2024 kommer vi att fasa ut GitHub-problem som feedbackmekanism för innehåll och ersätta det med ett nytt feedbacksystem. Mer information finns i: https://aka.ms/ContentUserFeedback.
Skicka och visa feedback för