Compartilhar via


Conectores microsoft.security 2020-01-01-preview

Definição de recurso do Bicep

O tipo de recurso de conectores pode ser implantado com operações direcionadas:

Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Security/connectors, adicione o Bicep a seguir ao modelo.

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

Objetos AuthenticationDetailsProperties

Defina a propriedade authenticationType para especificar o tipo de objeto.

Para awsAssumeRole, use:

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

Para awsCreds, use:

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

Para gcpCredentials, use:

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

Valores de propriedade

conectores

Nome Descrição Valor
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 1-260

Caracteres válidos:
Caracteres alfanuméricos, sublinhados e hifens.
properties Dados de configuração do conector ConnectorSettingProperties

ConnectorSettingProperties

Nome Descrição Valor
authenticationDetails Configurações para gerenciamento de autenticação, essas configurações são relevantes apenas para o conector de nuvem. AuthenticationDetailsProperties
hybridComputeSettings Configurações para gerenciamento de computação híbrida. Essas configurações são relevantes apenas para o Arc autoProvision (Computação Híbrida). HybridComputeSettingsProperties

AuthenticationDetailsProperties

Nome Descrição Valor
grantedPermissions As permissões detectadas na conta de nuvem. Matriz de cadeia de caracteres que contém qualquer um dos:
'AWS::AWSSecurityHubReadOnlyAccess'
'AWS::AmazonSSMAutomationRole'
'AWS::SecurityAudit'
'GCP::Security Center Administração Viewer'
authenticationType Definir o tipo de objeto awsAssumeRole
awsCreds
gcpCredentials (obrigatório)

AwAssumeRoleAuthenticationDetailsProperties

Nome Descrição Valor
authenticationType Conecte-se à sua conta de nuvem, pois a AWS usa credenciais de conta ou autenticação baseada em função. Para o GCP, use as credenciais da organização da conta. 'awsAssumeRole' (obrigatório)
awsAssumeRoleArn A ID de função assumida é um identificador que você pode usar para criar credenciais de segurança temporárias. cadeia de caracteres (obrigatório)
awsExternalId Um identificador exclusivo que é necessário quando você assume uma função em outra conta. cadeia de caracteres (obrigatório)

AwsCredsAuthenticationDetailsProperties

Nome Descrição Valor
authenticationType Conecte-se à sua conta de nuvem, pois a AWS usa credenciais de conta ou autenticação baseada em função. Para o GCP, use as credenciais da organização da conta. 'awsCreds' (obrigatório)
awsAccessKeyId Elemento de chave pública do objeto de credencial AWS (somente gravação) cadeia de caracteres (obrigatório)
awsSecretAccessKey Elemento de chave secreta do objeto de credencial AWS (somente gravação) cadeia de caracteres (obrigatório)

GcpCredentialsDetailsProperties

Nome Descrição Valor
authenticationType Conecte-se à sua conta de nuvem, pois a AWS usa credenciais de conta ou autenticação baseada em função. Para o GCP, use as credenciais da organização da conta. 'gcpCredentials' (obrigatório)
authProviderX509CertUrl Campo URL do certificado x509 do provedor de autenticação da chave de API (somente gravação) cadeia de caracteres (obrigatório)
authUri Campo URI de autenticação da chave de API (somente gravação) cadeia de caracteres (obrigatório)
Clientemail Campo email do cliente da chave de API (somente gravação) cadeia de caracteres (obrigatório)
clientId Campo ID do cliente da chave de API (somente gravação) cadeia de caracteres (obrigatório)
clientX509CertUrl Campo URL do certificado x509 do cliente da chave de API (somente gravação) cadeia de caracteres (obrigatório)
organizationId A ID da organização da conta de nuvem do GCP cadeia de caracteres (obrigatório)
privateKey Campo chave privada da chave de API (somente gravação) cadeia de caracteres (obrigatório)
privateKeyId Campo ID da chave privada da chave de API (somente gravação) cadeia de caracteres (obrigatório)
projectId Campo ID do projeto da chave de API (somente gravação) cadeia de caracteres (obrigatório)
tokenUri Campo URI do token da chave de API (somente gravação) cadeia de caracteres (obrigatório)
tipo Campo Tipo da chave de API (somente gravação) cadeia de caracteres (obrigatório)

HybridComputeSettingsProperties

Nome Descrição Valor
autoProvisionamento Se os agentes do Azure Arc (computação híbrida) devem ou não ser instalados automaticamente em computadores 'Off'
'On' (obrigatório)
proxyServer Para um computador não Azure que não está conectado diretamente à Internet, especifique um servidor proxy que o computador não Azure pode usar. ProxyServerProperties
region O local em que os metadados dos computadores serão armazenados string
resourceGroupName O nome do grupo de recursos em que os conectores do Arc (Computação Híbrida) estão conectados. string
servicePrincipal Um objeto para acessar recursos protegidos por um locatário Azure AD. ServicePrincipalProperties

ProxyServerProperties

Nome Descrição Valor
ip IP do servidor proxy string
porta porta do servidor proxy string

ServicePrincipalProperties

Nome Descrição Valor
applicationId ID do aplicativo da entidade de serviço. string
segredo Uma cadeia de caracteres secreta que o aplicativo usa para provar sua identidade também pode ser chamada de senha do aplicativo (somente gravação). string

Definição de recurso de modelo do ARM

O tipo de recurso de conectores pode ser implantado com operações direcionadas:

Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Security/connectors, adicione o JSON a seguir ao modelo.

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

Objetos AuthenticationDetailsProperties

Defina a propriedade authenticationType para especificar o tipo de objeto.

Para awsAssumeRole, use:

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

Para awsCreds, use:

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

Para gcpCredentials, use:

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

Valores de propriedade

conectores

Nome Descrição Valor
tipo O tipo de recurso 'Microsoft.Security/connectors'
apiVersion A versão da API do recurso '2020-01-01-preview'
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 1-260

Caracteres válidos:
Caracteres alfanuméricos, sublinhados e hifens.
properties Dados de configuração do conector ConnectorSettingProperties

ConnectorSettingProperties

Nome Descrição Valor
authenticationDetails Configurações para gerenciamento de autenticação, essas configurações são relevantes apenas para o conector de nuvem. AuthenticationDetailsProperties
hybridComputeSettings Configurações para gerenciamento de computação híbrida. Essas configurações são relevantes apenas para o Arc autoProvision (Computação Híbrida). HybridComputeSettingsProperties

AuthenticationDetailsProperties

Nome Descrição Valor
grantedPermissions As permissões detectadas na conta de nuvem. Matriz de cadeia de caracteres que contém qualquer um dos:
'AWS::AWSSecurityHubReadOnlyAccess'
'AWS::AmazonSSMAutomationRole'
'AWS::SecurityAudit'
'GCP::Security Center Administração Viewer'
authenticationType Definir o tipo de objeto awsAssumeRole
awsCreds
gcpCredentials (obrigatório)

AwAssumeRoleAuthenticationDetailsProperties

Nome Descrição Valor
authenticationType Conecte-se à sua conta de nuvem, pois a AWS usa credenciais de conta ou autenticação baseada em função. Para o GCP, use as credenciais da organização da conta. 'awsAssumeRole' (obrigatório)
awsAssumeRoleArn A ID de função assumida é um identificador que você pode usar para criar credenciais de segurança temporárias. cadeia de caracteres (obrigatório)
awsExternalId Um identificador exclusivo que é necessário quando você assume uma função em outra conta. cadeia de caracteres (obrigatório)

AwsCredsAuthenticationDetailsProperties

Nome Descrição Valor
authenticationType Conecte-se à sua conta de nuvem, pois a AWS usa credenciais de conta ou autenticação baseada em função. Para o GCP, use as credenciais da organização da conta. 'awsCreds' (obrigatório)
awsAccessKeyId Elemento de chave pública do objeto de credencial AWS (somente gravação) cadeia de caracteres (obrigatório)
awsSecretAccessKey Elemento de chave secreta do objeto de credencial AWS (somente gravação) cadeia de caracteres (obrigatório)

GcpCredentialsDetailsProperties

Nome Descrição Valor
authenticationType Conecte-se à sua conta de nuvem, pois a AWS usa credenciais de conta ou autenticação baseada em função. Para o GCP, use as credenciais da organização da conta. 'gcpCredentials' (obrigatório)
authProviderX509CertUrl Campo URL do certificado x509 do provedor de autenticação da chave de API (somente gravação) cadeia de caracteres (obrigatório)
authUri Campo URI de autenticação da chave de API (somente gravação) cadeia de caracteres (obrigatório)
Clientemail Campo email do cliente da chave de API (somente gravação) cadeia de caracteres (obrigatório)
clientId Campo ID do cliente da chave de API (somente gravação) cadeia de caracteres (obrigatório)
clientX509CertUrl Campo URL do certificado x509 do cliente da chave de API (somente gravação) cadeia de caracteres (obrigatório)
organizationId A ID da organização da conta de nuvem do GCP cadeia de caracteres (obrigatório)
privateKey Campo chave privada da chave de API (somente gravação) cadeia de caracteres (obrigatório)
privateKeyId Campo ID da chave privada da chave de API (somente gravação) cadeia de caracteres (obrigatório)
projectId Campo ID do projeto da chave de API (somente gravação) cadeia de caracteres (obrigatório)
tokenUri Campo URI do token da chave de API (somente gravação) cadeia de caracteres (obrigatório)
tipo Campo Tipo da chave de API (somente gravação) cadeia de caracteres (obrigatório)

HybridComputeSettingsProperties

Nome Descrição Valor
autoProvisionamento Se os agentes do Azure Arc (computação híbrida) devem ou não ser instalados automaticamente em computadores 'Off'
'On' (obrigatório)
proxyServer Para um computador não Azure que não está conectado diretamente à Internet, especifique um servidor proxy que o computador não Azure pode usar. ProxyServerProperties
region O local em que os metadados dos computadores serão armazenados string
resourceGroupName O nome do grupo de recursos em que os conectores do Arc (Computação Híbrida) estão conectados. string
servicePrincipal Um objeto para acessar recursos protegidos por um locatário Azure AD. ServicePrincipalProperties

ProxyServerProperties

Nome Descrição Valor
ip IP do servidor proxy string
porta porta do servidor proxy string

ServicePrincipalProperties

Nome Descrição Valor
applicationId ID do aplicativo da entidade de serviço. string
segredo Uma cadeia de caracteres secreta que o aplicativo usa para provar sua identidade também pode ser chamada de senha do aplicativo (somente gravação). string

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso de conectores pode ser implantado com operações direcionadas:

  • Assinaturas

Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Security/connectors, adicione o Terraform a seguir ao seu modelo.

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

Objetos AuthenticationDetailsProperties

Defina a propriedade authenticationType para especificar o tipo de objeto.

Para awsAssumeRole, use:

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

Para awsCreds, use:

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

Para gcpCredentials, use:

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

Valores de propriedade

conectores

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.Security/connectors@2020-01-01-preview"
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 1-260

Caracteres válidos:
Caracteres alfanuméricos, sublinhados e hifens.
parent_id Para implantar em uma assinatura, use a ID dessa assinatura. cadeia de caracteres (obrigatório)
properties Dados de configuração do conector ConnectorSettingProperties

ConnectorSettingProperties

Nome Descrição Valor
authenticationDetails Configurações para gerenciamento de autenticação, essas configurações são relevantes apenas para o conector de nuvem. AuthenticationDetailsProperties
hybridComputeSettings Configurações para gerenciamento de computação híbrida. Essas configurações são relevantes apenas para o Arc autoProvision (Computação Híbrida). HybridComputeSettingsProperties

AuthenticationDetailsProperties

Nome Descrição Valor
grantedPermissions As permissões detectadas na conta de nuvem. Matriz de cadeia de caracteres que contém qualquer um dos:
"AWS::AWSSecurityHubReadOnlyAccess"
"AWS::AmazonSSMAutomationRole"
"AWS::SecurityAudit"
"Visualizador de Administração da Central de Segurança::GCP"
authenticationType Definir o tipo de objeto awsAssumeRole
awsCreds
gcpCredentials (obrigatório)

AwAssumeRoleAuthenticationDetailsProperties

Nome Descrição Valor
authenticationType Conecte-se à sua conta de nuvem, pois a AWS usa credenciais de conta ou autenticação baseada em função. Para o GCP, use as credenciais da organização da conta. "awsAssumeRole" (obrigatório)
awsAssumeRoleArn A ID de função assumida é um identificador que você pode usar para criar credenciais de segurança temporárias. cadeia de caracteres (obrigatório)
awsExternalId Um identificador exclusivo que é necessário quando você assume uma função em outra conta. cadeia de caracteres (obrigatório)

AwsCredsAuthenticationDetailsProperties

Nome Descrição Valor
authenticationType Conecte-se à sua conta de nuvem, pois a AWS usa credenciais de conta ou autenticação baseada em função. Para o GCP, use as credenciais da organização da conta. "awsCreds" (obrigatório)
awsAccessKeyId Elemento de chave pública do objeto de credencial AWS (somente gravação) cadeia de caracteres (obrigatório)
awsSecretAccessKey Elemento de chave secreta do objeto de credencial AWS (somente gravação) cadeia de caracteres (obrigatório)

GcpCredentialsDetailsProperties

Nome Descrição Valor
authenticationType Conecte-se à sua conta de nuvem, pois a AWS usa credenciais de conta ou autenticação baseada em função. Para o GCP, use as credenciais da organização da conta. "gcpCredentials" (obrigatório)
authProviderX509CertUrl Campo URL do certificado x509 do provedor de autenticação da chave de API (somente gravação) cadeia de caracteres (obrigatório)
authUri Campo URI de autenticação da chave de API (somente gravação) cadeia de caracteres (obrigatório)
Clientemail Campo email do cliente da chave de API (somente gravação) cadeia de caracteres (obrigatório)
clientId Campo ID do cliente da chave de API (somente gravação) cadeia de caracteres (obrigatório)
clientX509CertUrl Campo URL do certificado x509 do cliente da chave de API (somente gravação) cadeia de caracteres (obrigatório)
organizationId A ID da organização da conta de nuvem do GCP cadeia de caracteres (obrigatório)
privateKey Campo chave privada da chave de API (somente gravação) cadeia de caracteres (obrigatório)
privateKeyId Campo ID da chave privada da chave de API (somente gravação) cadeia de caracteres (obrigatório)
projectId Campo ID do projeto da chave de API (somente gravação) cadeia de caracteres (obrigatório)
tokenUri Campo URI do token da chave de API (somente gravação) cadeia de caracteres (obrigatório)
tipo Campo Tipo da chave de API (somente gravação) cadeia de caracteres (obrigatório)

HybridComputeSettingsProperties

Nome Descrição Valor
autoProvisionamento Se os agentes do Azure Arc (computação híbrida) devem ou não ser instalados automaticamente em computadores "Desativado"
"Ativado" (obrigatório)
proxyServer Para um computador não Azure que não está conectado diretamente à Internet, especifique um servidor proxy que o computador não Azure pode usar. ProxyServerProperties
region O local em que os metadados dos computadores serão armazenados string
resourceGroupName O nome do grupo de recursos em que os conectores do Arc (Computação Híbrida) estão conectados. string
servicePrincipal Um objeto para acessar recursos protegidos por um locatário Azure AD. ServicePrincipalProperties

ProxyServerProperties

Nome Descrição Valor
ip IP do servidor proxy string
porta porta do servidor proxy string

ServicePrincipalProperties

Nome Descrição Valor
applicationId ID do aplicativo da entidade de serviço. string
segredo Uma cadeia de caracteres secreta que o aplicativo usa para provar sua identidade também pode ser chamada de senha do aplicativo (somente gravação). string