Compartilhar via

Conectores microsoft.security

Definição de recurso do Bicep

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

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

Formato de recurso

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

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

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

Microsoft.Security/connectors

Nome Descrição Valor
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Dados de configuração do conector ConnectorSettingProperties
escopo Use ao criar um recurso em um escopo diferente do escopo de implantação. Defina essa propriedade como o nome simbólico de um recurso para aplicar o recurso de extensão .

AuthenticationDetailsProperties

Nome Descrição Valor
tipoDeAutenticação Defina como 'awsAssumeRole' para o tipo AwAssumeRoleAuthenticationDetailsProperties. Defina como 'awsCreds' para o tipo AwsCredsAuthenticationDetailsProperties. Defina como 'gcpCredentials' para o tipo GcpCredentialsDetailsProperties. 'awsAssumeRole'
'awsCreds'
'gcpCredentials' (obrigatório)

AwAssumeRoleAuthenticationDetailsProperties

Nome Descrição Valor
tipoDeAutenticação 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
tipoDeAutenticação 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 do AWS (somente gravação) cadeia de caracteres (obrigatório)
awsSecretAccessKey Elemento chave secreta do objeto de credencial do AWS (somente gravação) cadeia de caracteres (obrigatório)

ConnectorSettingProperties

Nome Descrição Valor
autenticaçãoDetalhes Configurações para gerenciamento de autenticação, essas configurações são relevantes apenas para o conector de nuvem. AuthenticationDetailsProperties
Configurações de computação híbrida 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

GcpCredentialsDetailsProperties

Nome Descrição Valor
tipoDeAutenticação 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)
clienteE-mail Campo de email do cliente da chave de API (somente gravação) cadeia de caracteres (obrigatório)
ID do cliente 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)
ID da organização A ID da organização da conta de nuvem do GCP cadeia de caracteres (obrigatório)
chave privada Campo de chave privada da chave de API (somente gravação) cadeia de caracteres (obrigatório)
Identificação da Chave Privada Campo ID de chave privada da chave de API (somente gravação) cadeia de caracteres (obrigatório)
ID do projeto Campo ID do projeto da chave de API (somente gravação) cadeia de caracteres (obrigatório)
tokenUri Campo URI de 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'
'On' (obrigatório)
Servidor proxy Para um computador não Azure que não está conectado diretamente à Internet, especifique um servidor proxy que o computador que não seja do Azure pode usar. proxyServerProperties
região O local onde os metadados dos computadores serão armazenados cadeia
nomeDoGrupoDeRecursos O nome do grupo de recursos em que os conectores Arc (Computação Híbrida) estão conectados. cadeia
servicePrincipal Um objeto para acessar recursos protegidos por um locatário do Azure AD. ServicePrincipalProperties

ProxyServerProperties

Nome Descrição Valor
IP IP do servidor proxy cadeia
porta Porta do servidor proxy cadeia

ServicePrincipalProperties

Nome Descrição Valor
ID do aplicativo ID do aplicativo da entidade de serviço. cadeia
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). cadeia

Definição de recurso de modelo do ARM

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

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

Formato de recurso

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

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

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

Microsoft.Security/connectors

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

AuthenticationDetailsProperties

Nome Descrição Valor
tipoDeAutenticação Defina como 'awsAssumeRole' para o tipo AwAssumeRoleAuthenticationDetailsProperties. Defina como 'awsCreds' para o tipo AwsCredsAuthenticationDetailsProperties. Defina como 'gcpCredentials' para o tipo GcpCredentialsDetailsProperties. 'awsAssumeRole'
'awsCreds'
'gcpCredentials' (obrigatório)

AwAssumeRoleAuthenticationDetailsProperties

Nome Descrição Valor
tipoDeAutenticação 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
tipoDeAutenticação 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 do AWS (somente gravação) cadeia de caracteres (obrigatório)
awsSecretAccessKey Elemento chave secreta do objeto de credencial do AWS (somente gravação) cadeia de caracteres (obrigatório)

ConnectorSettingProperties

Nome Descrição Valor
autenticaçãoDetalhes Configurações para gerenciamento de autenticação, essas configurações são relevantes apenas para o conector de nuvem. AuthenticationDetailsProperties
Configurações de computação híbrida 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

GcpCredentialsDetailsProperties

Nome Descrição Valor
tipoDeAutenticação 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)
clienteE-mail Campo de email do cliente da chave de API (somente gravação) cadeia de caracteres (obrigatório)
ID do cliente 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)
ID da organização A ID da organização da conta de nuvem do GCP cadeia de caracteres (obrigatório)
chave privada Campo de chave privada da chave de API (somente gravação) cadeia de caracteres (obrigatório)
Identificação da Chave Privada Campo ID de chave privada da chave de API (somente gravação) cadeia de caracteres (obrigatório)
ID do projeto Campo ID do projeto da chave de API (somente gravação) cadeia de caracteres (obrigatório)
tokenUri Campo URI de 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'
'On' (obrigatório)
Servidor proxy Para um computador não Azure que não está conectado diretamente à Internet, especifique um servidor proxy que o computador que não seja do Azure pode usar. proxyServerProperties
região O local onde os metadados dos computadores serão armazenados cadeia
nomeDoGrupoDeRecursos O nome do grupo de recursos em que os conectores Arc (Computação Híbrida) estão conectados. cadeia
servicePrincipal Um objeto para acessar recursos protegidos por um locatário do Azure AD. ServicePrincipalProperties

ProxyServerProperties

Nome Descrição Valor
IP IP do servidor proxy cadeia
porta Porta do servidor proxy cadeia

ServicePrincipalProperties

Nome Descrição Valor
ID do aplicativo ID do aplicativo da entidade de serviço. cadeia
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). cadeia

Exemplos de uso

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

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

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de 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 = {
    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"
        }
      }
    }
  }
}

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

Microsoft.Security/connectors

Nome Descrição Valor
nome O nome do recurso cadeia de caracteres (obrigatório)
parent_id A ID do recurso ao qual aplicar esse recurso de extensão. cadeia de caracteres (obrigatório)
Propriedades Dados de configuração do conector ConnectorSettingProperties
tipo O tipo de recurso "Microsoft.Security/connectors@2020-01-01-preview"

AuthenticationDetailsProperties

Nome Descrição Valor
tipoDeAutenticação Defina como 'awsAssumeRole' para o tipo AwAssumeRoleAuthenticationDetailsProperties. Defina como 'awsCreds' para o tipo AwsCredsAuthenticationDetailsProperties. Defina como 'gcpCredentials' para o tipo GcpCredentialsDetailsProperties. 'awsAssumeRole'
'awsCreds'
'gcpCredentials' (obrigatório)

AwAssumeRoleAuthenticationDetailsProperties

Nome Descrição Valor
tipoDeAutenticação 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
tipoDeAutenticação 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 do AWS (somente gravação) cadeia de caracteres (obrigatório)
awsSecretAccessKey Elemento chave secreta do objeto de credencial do AWS (somente gravação) cadeia de caracteres (obrigatório)

ConnectorSettingProperties

Nome Descrição Valor
autenticaçãoDetalhes Configurações para gerenciamento de autenticação, essas configurações são relevantes apenas para o conector de nuvem. AuthenticationDetailsProperties
Configurações de computação híbrida 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

GcpCredentialsDetailsProperties

Nome Descrição Valor
tipoDeAutenticação 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)
clienteE-mail Campo de email do cliente da chave de API (somente gravação) cadeia de caracteres (obrigatório)
ID do cliente 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)
ID da organização A ID da organização da conta de nuvem do GCP cadeia de caracteres (obrigatório)
chave privada Campo de chave privada da chave de API (somente gravação) cadeia de caracteres (obrigatório)
Identificação da Chave Privada Campo ID de chave privada da chave de API (somente gravação) cadeia de caracteres (obrigatório)
ID do projeto Campo ID do projeto da chave de API (somente gravação) cadeia de caracteres (obrigatório)
tokenUri Campo URI de 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'
'On' (obrigatório)
Servidor proxy Para um computador não Azure que não está conectado diretamente à Internet, especifique um servidor proxy que o computador que não seja do Azure pode usar. proxyServerProperties
região O local onde os metadados dos computadores serão armazenados cadeia
nomeDoGrupoDeRecursos O nome do grupo de recursos em que os conectores Arc (Computação Híbrida) estão conectados. cadeia
servicePrincipal Um objeto para acessar recursos protegidos por um locatário do Azure AD. ServicePrincipalProperties

ProxyServerProperties

Nome Descrição Valor
IP IP do servidor proxy cadeia
porta Porta do servidor proxy cadeia

ServicePrincipalProperties

Nome Descrição Valor
ID do aplicativo ID do aplicativo da entidade de serviço. cadeia
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). cadeia
  • Last updated on