Conectores Microsoft.Security
Definição de recurso do Bicep
O tipo de recurso dos conectores pode ser implementado com operações que visam:
- Subscrições - Veja os comandos de implementação da subscrição
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.Security/conectores, adicione o seguinte Bicep ao seu 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, utilize:
authenticationType: 'awsAssumeRole'
awsAssumeRoleArn: 'string'
awsExternalId: 'string'
Para awsCreds, utilize:
authenticationType: 'awsCreds'
awsAccessKeyId: 'string'
awsSecretAccessKey: 'string'
Para gcpCredentials, utilize:
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 (obrigatório) Limite de carateres: 1-260 Carateres válidos: Alfanuméricos, carateres de sublinhado e hífenes. |
propriedades | Dados de definição do conector | ConnectorSettingProperties |
ConnectorSettingProperties
Nome | Descrição | Valor |
---|---|---|
authenticationDetails | Definições para a gestão de autenticação, estas definições são relevantes apenas para o conector da cloud. | AuthenticationDetailsProperties |
hybridComputeSettings | Definições para a gestão de computação híbrida. Estas definições são relevantes apenas para o Arc autoProvision (Computação Híbrida). | HybridComputeSettingsProperties |
AuthenticationDetailsProperties
Nome | Descrição | Valor |
---|---|---|
grantedPermissions | As permissões detetadas na conta na cloud. | Matriz de cadeias que contém qualquer um dos seguintes: "AWS::AWSSecurityHubReadOnlyAccess" 'AWS::AmazonSSMAutomationRole' 'AWS::SecurityAudit' "GCP::Visualizador de Administração do Centro de Segurança" |
authenticationType | Definir o tipo de objeto |
awsAssumeRole awsCreds gcpCredentials (obrigatório) |
AwAssumeRoleAuthenticationDetailsProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Ligue-se à sua conta na cloud, para o AWS, utilize credenciais de conta ou autenticação baseada em funções. Para o GCP, utilize as credenciais da organização da conta. | "awsAssumeRole" (obrigatório) |
awsAssumeRoleArn | Assumiu que o ID da função é um identificador que pode utilizar para criar credenciais de segurança temporárias. | cadeia (obrigatório) |
awsExternalId | Um identificador exclusivo que é necessário quando assume uma função noutra conta. | cadeia (obrigatório) |
AwsCredsAuthenticationDetailsProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Ligue-se à sua conta na cloud, para o AWS, utilize credenciais de conta ou autenticação baseada em funções. Para o GCP, utilize as credenciais da organização da conta. | "awsCreds" (obrigatório) |
awsAccessKeyId | Elemento chave pública do objeto de credencial do AWS (apenas escrita) | cadeia (obrigatório) |
awsSecretAccessKey | Elemento chave secreta do objeto de credencial do AWS (apenas escrita) | cadeia (obrigatório) |
GcpCredentialsDetailsProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Ligue-se à sua conta na cloud, para o AWS, utilize credenciais de conta ou autenticação baseada em funções. Para o GCP, utilize as credenciais da organização da conta. | "gcpCredentials" (obrigatório) |
authProviderX509CertUrl | Campo de URL do certificado x509 do fornecedor de autenticação da chave de API (apenas escrita) | cadeia (obrigatório) |
authUri | Campo URI de autenticação da chave de API (apenas escrita) | cadeia (obrigatório) |
clientEmail | Campo de e-mail do cliente da chave de API (apenas escrita) | cadeia (obrigatório) |
clientId | Campo ID de cliente da chave de API (apenas escrita) | cadeia (obrigatório) |
clientX509CertUrl | Campo de URL do certificado x509 do cliente da chave de API (apenas escrita) | cadeia (obrigatório) |
organizationId | O ID da organização da conta na cloud do GCP | cadeia (obrigatório) |
privateKey | Campo de chave privada da chave de API (apenas escrita) | cadeia (obrigatório) |
privateKeyId | Campo ID da chave privada da chave de API (apenas escrita) | cadeia (obrigatório) |
projectId | Campo ID do Projeto da chave de API (apenas escrita) | cadeia (obrigatório) |
tokenUri | Campo URI do token da chave de API (apenas escrita) | cadeia (obrigatório) |
tipo | Campo Tipo da chave de API (apenas escrita) | cadeia (obrigatório) |
HybridComputeSettingsProperties
Nome | Descrição | Valor |
---|---|---|
aprovisionar automaticamente | Se pretende ou não instalar automaticamente agentes do Azure Arc (computação híbrida) em computadores | 'Desativado' "Ativado" (obrigatório) |
proxyServer | Para um computador não Azure que não esteja ligado diretamente à Internet, especifique um servidor proxy que o computador não Azure possa utilizar. | ProxyServerProperties |
region | A localização onde os metadados das máquinas serão armazenados | string |
resourceGroupName | O nome do grupo de recursos onde os conectores do Arc (Computação Híbrida) estão ligados. | string |
servicePrincipal | Um objeto para aceder a recursos protegidos por um inquilino 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 da Aplicação do principal de serviço. | string |
segredo | Uma cadeia secreta que a aplicação utiliza para provar a sua identidade, também pode ser referida como palavra-passe de aplicação (apenas escrita). | string |
Definição de recurso do modelo arm
O tipo de recurso dos conectores pode ser implementado com operações que visam:
- Subscrições – veja os comandos de implementação da subscrição
Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.Security/conectores, adicione o seguinte JSON ao seu 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, utilize:
"authenticationType": "awsAssumeRole",
"awsAssumeRoleArn": "string",
"awsExternalId": "string"
Para awsCreds, utilize:
"authenticationType": "awsCreds",
"awsAccessKeyId": "string",
"awsSecretAccessKey": "string"
Para gcpCredentials, utilize:
"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/conectores" |
apiVersion | A versão da API de recursos | '2020-01-01-preview' |
name | O nome do recurso | cadeia (obrigatório) Limite de carateres: 1-260 Carateres válidos: Alfanuméricos, carateres de sublinhado e hífenes. |
propriedades | Dados de definição do conector | ConnectorSettingProperties |
ConnectorSettingProperties
Nome | Descrição | Valor |
---|---|---|
authenticationDetails | Definições para a gestão de autenticação, estas definições são relevantes apenas para o conector da cloud. | AuthenticationDetailsProperties |
hybridComputeSettings | Definições para a gestão de computação híbrida. Estas definições são relevantes apenas para o Arc autoProvision (Computação Híbrida). | HybridComputeSettingsProperties |
AuthenticationDetailsProperties
Nome | Descrição | Valor |
---|---|---|
grantedPermissions | As permissões detetadas na conta na cloud. | Matriz de cadeias que contém qualquer um dos seguintes: "AWS::AWSSecurityHubReadOnlyAccess" 'AWS::AmazonSSMAutomationRole' 'AWS::SecurityAudit' "GCP::Visualizador de Administração do Centro de Segurança" |
authenticationType | Definir o tipo de objeto |
awsAssumeRole awsCreds gcpCredentials (obrigatório) |
AwAssumeRoleAuthenticationDetailsProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Ligue-se à sua conta na cloud, para o AWS, utilize credenciais de conta ou autenticação baseada em funções. Para o GCP, utilize as credenciais da organização da conta. | "awsAssumeRole" (obrigatório) |
awsAssumeRoleArn | Assumiu que o ID da função é um identificador que pode utilizar para criar credenciais de segurança temporárias. | cadeia (obrigatório) |
awsExternalId | Um identificador exclusivo que é necessário quando assume uma função noutra conta. | cadeia (obrigatório) |
AwsCredsAuthenticationDetailsProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Ligue-se à sua conta na cloud, para o AWS, utilize credenciais de conta ou autenticação baseada em funções. Para o GCP, utilize as credenciais da organização da conta. | "awsCreds" (obrigatório) |
awsAccessKeyId | Elemento chave pública do objeto de credencial do AWS (apenas escrita) | cadeia (obrigatório) |
awsSecretAccessKey | Elemento chave secreta do objeto de credencial do AWS (apenas escrita) | cadeia (obrigatório) |
GcpCredentialsDetailsProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Ligue-se à sua conta na cloud, para o AWS, utilize credenciais de conta ou autenticação baseada em funções. Para o GCP, utilize as credenciais da organização da conta. | "gcpCredentials" (obrigatório) |
authProviderX509CertUrl | Campo de URL do certificado x509 do fornecedor de autenticação da chave de API (apenas escrita) | cadeia (obrigatório) |
authUri | Campo URI de autenticação da chave de API (apenas escrita) | cadeia (obrigatório) |
clientEmail | Campo de e-mail do cliente da chave de API (apenas escrita) | cadeia (obrigatório) |
clientId | Campo ID de cliente da chave de API (apenas escrita) | cadeia (obrigatório) |
clientX509CertUrl | Campo de URL do certificado x509 do cliente da chave de API (apenas escrita) | cadeia (obrigatório) |
organizationId | O ID da organização da conta na cloud do GCP | cadeia (obrigatório) |
privateKey | Campo chave privada da chave de API (apenas escrita) | cadeia (obrigatório) |
privateKeyId | Campo ID da chave privada da chave de API (apenas escrita) | cadeia (obrigatório) |
projectId | Campo ID do Projeto da chave de API (apenas escrita) | cadeia (obrigatório) |
tokenUri | Campo URI do token da chave de API (apenas escrita) | cadeia (obrigatório) |
tipo | Tipo de campo da chave de API (apenas escrita) | cadeia (obrigatório) |
HybridComputeSettingsProperties
Nome | Descrição | Valor |
---|---|---|
autoProvisionar | Se pretende ou não instalar automaticamente agentes do Azure Arc (computação híbrida) em máquinas | 'Desligado' "Ativado" (obrigatório) |
proxyServer | Para um computador não Azure que não esteja ligado diretamente à Internet, especifique um servidor proxy que a máquina não Azure possa utilizar. | ProxyServerProperties |
region | A localização onde os metadados das máquinas serão armazenados | string |
resourceGroupName | O nome do grupo de recursos onde os conectores arc (Computação Híbrida) estão ligados. | string |
servicePrincipal | Um objeto para aceder a recursos protegidos por um inquilino 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 da aplicação do principal de serviço. | string |
segredo | Uma cadeia secreta que a aplicação utiliza para provar a sua identidade, também pode ser referida como palavra-passe de aplicação (apenas escrita). | string |
Definição de recurso do Terraform (fornecedor AzAPI)
O tipo de recurso dos conectores pode ser implementado com operações que visam:
- Subscrições
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.Security/conectores, adicione o seguinte Terraform 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, utilize:
authenticationType = "awsAssumeRole"
awsAssumeRoleArn = "string"
awsExternalId = "string"
Para awsCreds, utilize:
authenticationType = "awsCreds"
awsAccessKeyId = "string"
awsSecretAccessKey = "string"
Para gcpCredentials, utilize:
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 (obrigatório) Limite de carateres: 1-260 Carateres válidos: Alfanuméricos, carateres de sublinhado e hífenes. |
parent_id | Para implementar numa subscrição, utilize o ID dessa subscrição. | cadeia (obrigatório) |
propriedades | Dados de definição do conector | ConnectorSettingProperties |
ConnectorSettingProperties
Nome | Descrição | Valor |
---|---|---|
authenticationDetails | Definições para a gestão de autenticação, estas definições são relevantes apenas para o conector da cloud. | AuthenticationDetailsProperties |
hybridComputeSettings | Definições para a gestão de computação híbrida. Estas definições são relevantes apenas para o Arc autoProvision (Computação Híbrida). | HybridComputeSettingsProperties |
AuthenticationDetailsProperties
Nome | Descrição | Valor |
---|---|---|
grantedPermissions | As permissões detetadas na conta na cloud. | Matriz de cadeias que contém qualquer um dos seguintes: "AWS::AWSSecurityHubReadOnlyAccess" "AWS::AmazonSSMAutomationRole" "AWS::SecurityAudit" "GCP::Visualizador de Administração do Centro de Segurança" |
authenticationType | Definir o tipo de objeto |
awsAssumeRole awsCreds gcpCredentials (obrigatório) |
AwAssumeRoleAuthenticationDetailsProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Ligue-se à sua conta na cloud, para o AWS, utilize credenciais de conta ou autenticação baseada em funções. Para o GCP, utilize as credenciais da organização da conta. | "awsAssumeRole" (obrigatório) |
awsAssumeRoleArn | Assumiu que o ID da função é um identificador que pode utilizar para criar credenciais de segurança temporárias. | cadeia (obrigatório) |
awsExternalId | Um identificador exclusivo que é necessário quando assume uma função noutra conta. | cadeia (obrigatório) |
AwsCredsAuthenticationDetailsProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Ligue-se à sua conta na cloud, para o AWS, utilize credenciais de conta ou autenticação baseada em funções. Para o GCP, utilize as credenciais da organização da conta. | "awsCreds" (obrigatório) |
awsAccessKeyId | Elemento chave pública do objeto de credencial do AWS (apenas escrita) | cadeia (obrigatório) |
awsSecretAccessKey | Elemento chave secreta do objeto de credencial do AWS (apenas escrita) | cadeia (obrigatório) |
GcpCredentialsDetailsProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Ligue-se à sua conta na cloud, para o AWS, utilize credenciais de conta ou autenticação baseada em funções. Para o GCP, utilize as credenciais da organização da conta. | "gcpCredentials" (obrigatório) |
authProviderX509CertUrl | Campo de URL do certificado x509 do fornecedor de autenticação da chave de API (apenas escrita) | cadeia (obrigatório) |
authUri | Campo URI de autenticação da chave de API (apenas escrita) | cadeia (obrigatório) |
clientEmail | Campo de e-mail do cliente da chave de API (apenas escrita) | cadeia (obrigatório) |
clientId | Campo ID de cliente da chave de API (apenas escrita) | cadeia (obrigatório) |
clientX509CertUrl | Campo de URL do certificado x509 do cliente da chave de API (apenas escrita) | cadeia (obrigatório) |
organizationId | O ID da organização da conta na cloud do GCP | cadeia (obrigatório) |
privateKey | Campo chave privada da chave de API (apenas escrita) | cadeia (obrigatório) |
privateKeyId | Campo ID da chave privada da chave de API (apenas escrita) | cadeia (obrigatório) |
projectId | Campo ID do Projeto da chave de API (apenas escrita) | cadeia (obrigatório) |
tokenUri | Campo URI do token da chave de API (apenas escrita) | cadeia (obrigatório) |
tipo | Tipo de campo da chave de API (apenas escrita) | cadeia (obrigatório) |
HybridComputeSettingsProperties
Nome | Descrição | Valor |
---|---|---|
autoProvisionar | Se pretende ou não instalar automaticamente agentes do Azure Arc (computação híbrida) em máquinas | "Desligado" "Ativado" (obrigatório) |
proxyServer | Para um computador não Azure que não esteja ligado diretamente à Internet, especifique um servidor proxy que a máquina não Azure possa utilizar. | ProxyServerProperties |
region | A localização onde os metadados das máquinas serão armazenados | string |
resourceGroupName | O nome do grupo de recursos onde os conectores arc (Computação Híbrida) estão ligados. | string |
servicePrincipal | Um objeto para aceder a recursos protegidos por um inquilino 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 da aplicação do principal de serviço. | string |
segredo | Uma cadeia secreta que a aplicação utiliza para provar a sua identidade, também pode ser referida como palavra-passe de aplicação (apenas escrita). | string |