Nota
O acesso a esta página requer autorização. Podes tentar iniciar sessão ou mudar de diretório.
O acesso a esta página requer autorização. Podes tentar mudar de diretório.
Definição de recursos do bíceps
O tipo de recurso conectores pode ser implantado com operações que visam:
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.Security/connectors, adicione o seguinte Bíceps 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/conectores
| Designação | Descrição | Valor |
|---|---|---|
| Designação | O nome do recurso | string (obrigatório) |
| propriedades | Dados de configuração do conector | ConnectorSettingProperties |
| âmbito | 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
| Designação | Descrição | Valor |
|---|---|---|
| tipo de autenticaçã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
| Designação | Descrição | Valor |
|---|---|---|
| tipo de autenticação | Conecte-se à sua conta na nuvem, para que a AWS use as credenciais da conta ou a autenticação baseada em função. Para GCP, use credenciais de organização de conta. | 'awsAssumeRole' (obrigatório) |
| awsAssumeRoleArn | ID de função assumida é um identificador que você pode usar para criar credenciais de segurança temporárias. | string (obrigatório) |
| awsExternalId | Um identificador exclusivo que é necessário quando você assume uma função em outra conta. | string (obrigatório) |
AwsCredsAuthenticationDetailsProperties
| Designação | Descrição | Valor |
|---|---|---|
| tipo de autenticação | Conecte-se à sua conta na nuvem, para que a AWS use as credenciais da conta ou a autenticação baseada em função. Para GCP, use credenciais de organização de conta. | 'awsCreds' (obrigatório) |
| awsAccessKeyId | Elemento de chave pública do objeto de credencial da AWS (somente gravação) | string (obrigatório) |
| awsSecretAccessKey | Elemento de chave secreto do objeto de credencial da AWS (somente gravação) | string (obrigatório) |
ConnectorSettingProperties
| Designação | 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 |
| 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 |
GcpCredentialsDetailsProperties
| Designação | Descrição | Valor |
|---|---|---|
| tipo de autenticação | Conecte-se à sua conta na nuvem, para que a AWS use as credenciais da conta ou a autenticação baseada em função. Para GCP, use credenciais de organização de conta. | 'gcpCredentials' (obrigatório) |
| authProviderX509CertUrl | Campo URL do certificado x509 do provedor de autenticação da chave da API (somente gravação) | string (obrigatório) |
| authUri | Campo URI de autenticação da chave API (somente gravação) | string (obrigatório) |
| e-mail do cliente | Campo de e-mail do cliente da chave da API (somente gravação) | string (obrigatório) |
| ID do cliente | Campo ID do Cliente da chave API (somente gravação) | string (obrigatório) |
| clientX509CertUrl | Campo URL do certificado x509 do cliente da chave API (somente gravação) | string (obrigatório) |
| organizationId | O ID da organização da conta de nuvem do GCP | string (obrigatório) |
| chave privada | Campo de chave privada da chave API (somente gravação) | string (obrigatório) |
| privateKeyId | Campo ID de chave privada da chave API (somente gravação) | string (obrigatório) |
| projectId | Campo ID do projeto da chave API (somente gravação) | string (obrigatório) |
| tokenUri | Campo URI de token da chave API (somente gravação) | string (obrigatório) |
| tipo | Campo Tipo da chave API (somente gravação) | string (obrigatório) |
HybridComputeSettingsProperties
| Designação | Descrição | Valor |
|---|---|---|
| autoProvisionamento | Instalar ou não automaticamente os agentes do Azure Arc (computação híbrida) em máquinas | 'Desligado' 'Ligado' (obrigatório) |
| servidor proxy | Para uma máquina que não seja do Azure que não esteja conectada diretamente à Internet, especifique um servidor proxy que a máquina que não seja do Azure possa usar. | ProxyServerProperties |
| região | O local onde os metadados das máquinas serão armazenados | cadeia (de caracteres) |
| nomeDoGrupoDeRecursos | O nome do grupo de recursos onde os conectores Arc (Computação Híbrida) estão conectados. | cadeia (de caracteres) |
| servicePrincipal | Um objeto para acessar recursos protegidos por um locatário do Azure AD. | ServicePrincipalProperties |
ProxyServerProperties
| Designação | Descrição | Valor |
|---|---|---|
| IP | IP do servidor proxy | cadeia (de caracteres) |
| porta | Porta do servidor proxy | cadeia (de caracteres) |
ServicePrincipalProperties
| Designação | Descrição | Valor |
|---|---|---|
| applicationId | ID do aplicativo da entidade de serviço. | cadeia (de caracteres) |
| segredo | Uma cadeia de caracteres secreta que o aplicativo usa para provar sua identidade, também pode ser referida como senha do aplicativo (somente gravação). | cadeia (de caracteres) |
Definição de recurso de modelo ARM
O tipo de recurso conectores pode ser implantado com operações que visam:
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.Security/connectors, adicione o seguinte JSON 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/conectores
| Designação | Descrição | Valor |
|---|---|---|
| Versão da API | A versão api | '2020-01-01-pré-visualização' |
| Designação | O nome do recurso | string (obrigatório) |
| propriedades | Dados de configuração do conector | ConnectorSettingProperties |
| tipo | O tipo de recurso | 'Microsoft.Security/conectores' |
AuthenticationDetailsProperties
| Designação | Descrição | Valor |
|---|---|---|
| tipo de autenticaçã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
| Designação | Descrição | Valor |
|---|---|---|
| tipo de autenticação | Conecte-se à sua conta na nuvem, para que a AWS use as credenciais da conta ou a autenticação baseada em função. Para GCP, use credenciais de organização de conta. | 'awsAssumeRole' (obrigatório) |
| awsAssumeRoleArn | ID de função assumida é um identificador que você pode usar para criar credenciais de segurança temporárias. | string (obrigatório) |
| awsExternalId | Um identificador exclusivo que é necessário quando você assume uma função em outra conta. | string (obrigatório) |
AwsCredsAuthenticationDetailsProperties
| Designação | Descrição | Valor |
|---|---|---|
| tipo de autenticação | Conecte-se à sua conta na nuvem, para que a AWS use as credenciais da conta ou a autenticação baseada em função. Para GCP, use credenciais de organização de conta. | 'awsCreds' (obrigatório) |
| awsAccessKeyId | Elemento de chave pública do objeto de credencial da AWS (somente gravação) | string (obrigatório) |
| awsSecretAccessKey | Elemento de chave secreto do objeto de credencial da AWS (somente gravação) | string (obrigatório) |
ConnectorSettingProperties
| Designação | 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 |
| 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 |
GcpCredentialsDetailsProperties
| Designação | Descrição | Valor |
|---|---|---|
| tipo de autenticação | Conecte-se à sua conta na nuvem, para que a AWS use as credenciais da conta ou a autenticação baseada em função. Para GCP, use credenciais de organização de conta. | 'gcpCredentials' (obrigatório) |
| authProviderX509CertUrl | Campo URL do certificado x509 do provedor de autenticação da chave da API (somente gravação) | string (obrigatório) |
| authUri | Campo URI de autenticação da chave API (somente gravação) | string (obrigatório) |
| e-mail do cliente | Campo de e-mail do cliente da chave da API (somente gravação) | string (obrigatório) |
| ID do cliente | Campo ID do Cliente da chave API (somente gravação) | string (obrigatório) |
| clientX509CertUrl | Campo URL do certificado x509 do cliente da chave API (somente gravação) | string (obrigatório) |
| organizationId | O ID da organização da conta de nuvem do GCP | string (obrigatório) |
| chave privada | Campo de chave privada da chave API (somente gravação) | string (obrigatório) |
| privateKeyId | Campo ID de chave privada da chave API (somente gravação) | string (obrigatório) |
| projectId | Campo ID do projeto da chave API (somente gravação) | string (obrigatório) |
| tokenUri | Campo URI de token da chave API (somente gravação) | string (obrigatório) |
| tipo | Campo Tipo da chave API (somente gravação) | string (obrigatório) |
HybridComputeSettingsProperties
| Designação | Descrição | Valor |
|---|---|---|
| autoProvisionamento | Instalar ou não automaticamente os agentes do Azure Arc (computação híbrida) em máquinas | 'Desligado' 'Ligado' (obrigatório) |
| servidor proxy | Para uma máquina que não seja do Azure que não esteja conectada diretamente à Internet, especifique um servidor proxy que a máquina que não seja do Azure possa usar. | ProxyServerProperties |
| região | O local onde os metadados das máquinas serão armazenados | cadeia (de caracteres) |
| nomeDoGrupoDeRecursos | O nome do grupo de recursos onde os conectores Arc (Computação Híbrida) estão conectados. | cadeia (de caracteres) |
| servicePrincipal | Um objeto para acessar recursos protegidos por um locatário do Azure AD. | ServicePrincipalProperties |
ProxyServerProperties
| Designação | Descrição | Valor |
|---|---|---|
| IP | IP do servidor proxy | cadeia (de caracteres) |
| porta | Porta do servidor proxy | cadeia (de caracteres) |
ServicePrincipalProperties
| Designação | Descrição | Valor |
|---|---|---|
| applicationId | ID do aplicativo da entidade de serviço. | cadeia (de caracteres) |
| segredo | Uma cadeia de caracteres secreta que o aplicativo usa para provar sua identidade, também pode ser referida como senha do aplicativo (somente gravação). | cadeia (de caracteres) |
Exemplos de uso
Definição de recursos Terraform (provedor AzAPI)
O tipo de recurso conectores pode ser implantado com operações que visam:
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.Security/connectors, 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 = {
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/conectores
| Designação | Descrição | Valor |
|---|---|---|
| Designação | O nome do recurso | string (obrigatório) |
| parent_id | A ID do recurso ao qual aplicar esse recurso de extensão. | string (obrigatório) |
| propriedades | Dados de configuração do conector | ConnectorSettingProperties |
| tipo | O tipo de recurso | "Microsoft.Security/connectors@2020-01-01-preview" |
AuthenticationDetailsProperties
| Designação | Descrição | Valor |
|---|---|---|
| tipo de autenticaçã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
| Designação | Descrição | Valor |
|---|---|---|
| tipo de autenticação | Conecte-se à sua conta na nuvem, para que a AWS use as credenciais da conta ou a autenticação baseada em função. Para GCP, use credenciais de organização de conta. | 'awsAssumeRole' (obrigatório) |
| awsAssumeRoleArn | ID de função assumida é um identificador que você pode usar para criar credenciais de segurança temporárias. | string (obrigatório) |
| awsExternalId | Um identificador exclusivo que é necessário quando você assume uma função em outra conta. | string (obrigatório) |
AwsCredsAuthenticationDetailsProperties
| Designação | Descrição | Valor |
|---|---|---|
| tipo de autenticação | Conecte-se à sua conta na nuvem, para que a AWS use as credenciais da conta ou a autenticação baseada em função. Para GCP, use credenciais de organização de conta. | 'awsCreds' (obrigatório) |
| awsAccessKeyId | Elemento de chave pública do objeto de credencial da AWS (somente gravação) | string (obrigatório) |
| awsSecretAccessKey | Elemento de chave secreto do objeto de credencial da AWS (somente gravação) | string (obrigatório) |
ConnectorSettingProperties
| Designação | 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 |
| 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 |
GcpCredentialsDetailsProperties
| Designação | Descrição | Valor |
|---|---|---|
| tipo de autenticação | Conecte-se à sua conta na nuvem, para que a AWS use as credenciais da conta ou a autenticação baseada em função. Para GCP, use credenciais de organização de conta. | 'gcpCredentials' (obrigatório) |
| authProviderX509CertUrl | Campo URL do certificado x509 do provedor de autenticação da chave da API (somente gravação) | string (obrigatório) |
| authUri | Campo URI de autenticação da chave API (somente gravação) | string (obrigatório) |
| e-mail do cliente | Campo de e-mail do cliente da chave da API (somente gravação) | string (obrigatório) |
| ID do cliente | Campo ID do Cliente da chave API (somente gravação) | string (obrigatório) |
| clientX509CertUrl | Campo URL do certificado x509 do cliente da chave API (somente gravação) | string (obrigatório) |
| organizationId | O ID da organização da conta de nuvem do GCP | string (obrigatório) |
| chave privada | Campo de chave privada da chave API (somente gravação) | string (obrigatório) |
| privateKeyId | Campo ID de chave privada da chave API (somente gravação) | string (obrigatório) |
| projectId | Campo ID do projeto da chave API (somente gravação) | string (obrigatório) |
| tokenUri | Campo URI de token da chave API (somente gravação) | string (obrigatório) |
| tipo | Campo Tipo da chave API (somente gravação) | string (obrigatório) |
HybridComputeSettingsProperties
| Designação | Descrição | Valor |
|---|---|---|
| autoProvisionamento | Instalar ou não automaticamente os agentes do Azure Arc (computação híbrida) em máquinas | 'Desligado' 'Ligado' (obrigatório) |
| servidor proxy | Para uma máquina que não seja do Azure que não esteja conectada diretamente à Internet, especifique um servidor proxy que a máquina que não seja do Azure possa usar. | ProxyServerProperties |
| região | O local onde os metadados das máquinas serão armazenados | cadeia (de caracteres) |
| nomeDoGrupoDeRecursos | O nome do grupo de recursos onde os conectores Arc (Computação Híbrida) estão conectados. | cadeia (de caracteres) |
| servicePrincipal | Um objeto para acessar recursos protegidos por um locatário do Azure AD. | ServicePrincipalProperties |
ProxyServerProperties
| Designação | Descrição | Valor |
|---|---|---|
| IP | IP do servidor proxy | cadeia (de caracteres) |
| porta | Porta do servidor proxy | cadeia (de caracteres) |
ServicePrincipalProperties
| Designação | Descrição | Valor |
|---|---|---|
| applicationId | ID do aplicativo da entidade de serviço. | cadeia (de caracteres) |
| segredo | Uma cadeia de caracteres secreta que o aplicativo usa para provar sua identidade, também pode ser referida como senha do aplicativo (somente gravação). | cadeia (de caracteres) |