Соединители Microsoft.Security

Определение ресурса Bicep

Тип ресурса соединителей можно развернуть с помощью операций, предназначенных для:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.Security/connectors, добавьте следующий Bicep в шаблон.

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

Объекты AuthenticationDetailsProperties

Задайте свойство authenticationType , чтобы указать тип объекта .

Для awsAssumeRole используйте:

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

Для awsCreds используйте:

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

Для gcpCredentials используйте:

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

Значения свойств

соединители

Имя Описание Значение
name имя ресурса. строка (обязательно)

Ограничение символов: 1–260

Допустимые символы:
Буквенно-цифровые символы, символы подчеркивания и дефисы.
properties Данные параметров соединителя ConnectorSettingProperties

ConnectorSettingProperties

Имя Описание Значение
authenticationDetails Параметры управления проверкой подлинности. Эти параметры относятся только к облачному соединителю. AuthenticationDetailsProperties
hybridComputeSettings Параметры для управления гибридными вычислениями. Эти параметры применимы только для автоматической подготовки Arc (гибридных вычислений). HybridComputeSettingsProperties

AuthenticationDetailsProperties

Имя Описание Значение
grantedPermissions Разрешения, обнаруженные в облачной учетной записи. Массив строк, содержащий любой из:
AWS::AWSSecurityHubReadOnlyAccess
AWS::AmazonSSMAutomationRole
AWS::SecurityAudit
'GCP::Security Center Администратор Viewer'
authenticationType Установка типа объекта awsAssumeRole
awsCreds
gcpCredentials (обязательно)

AwAssumeRoleAuthenticationDetailsProperties

Имя Описание Значение
authenticationType Подключитесь к облачной учетной записи для AWS используйте учетные данные учетной записи или проверку подлинности на основе ролей. Для GCP используйте учетные данные организации. awsAssumeRole (обязательно)
awsAssumeRoleArn Идентификатор принятой роли — это идентификатор, который можно использовать для создания временных учетных данных безопасности. строка (обязательно)
awsExternalId Уникальный идентификатор, который требуется, если вы принимаете роль в другой учетной записи. строка (обязательно)

AwsCredsAuthenticationDetailsProperties

Имя Описание Значение
authenticationType Подключитесь к облачной учетной записи для AWS используйте учетные данные учетной записи или проверку подлинности на основе ролей. Для GCP используйте учетные данные организации. awsCreds (обязательно)
awsAccessKeyId Элемент открытого ключа объекта учетных данных AWS (только для записи) строка (обязательно)
awsSecretAccessKey Элемент secret key объекта учетных данных AWS (только запись) строка (обязательно)

GcpCredentialsDetailsProperties

Имя Описание Значение
authenticationType Подключитесь к облачной учетной записи для AWS используйте учетные данные учетной записи или проверку подлинности на основе ролей. Для GCP используйте учетные данные организации. 'gcpCredentials' (обязательно)
authProviderX509CertUrl Поле URL-адреса сертификата x509 поставщика проверки подлинности ключа API (только для записи) строка (обязательно)
authUri Поле URI проверки подлинности ключа API (только для записи) строка (обязательно)
clientEmail Поле электронной почты клиента ключа API (только для записи) строка (обязательно)
clientid Поле идентификатора клиента ключа API (только для записи) строка (обязательно)
clientX509CertUrl Поле URL-адреса сертификата x509 клиента ключа API (только для записи) строка (обязательно)
organizationId Идентификатор организации облачной учетной записи GCP строка (обязательно)
privateKey Поле закрытого ключа API (только для записи) строка (обязательно)
privateKeyId Поле идентификатора закрытого ключа API (только запись) строка (обязательно)
projectId Поле Идентификатор проекта ключа API (только для записи) строка (обязательно)
tokenUri Поле URI маркера ключа API (только для записи) строка (обязательно)
тип Поле Type ключа API (только для записи) строка (обязательно)

HybridComputeSettingsProperties

Имя Описание Значение
autoProvision Указывает, следует ли автоматически устанавливать агенты Azure Arc (гибридные вычислительные ресурсы) на компьютерах "Выкл."
"Включено" (обязательно)
proxyServer Для компьютера, отличного от Azure, который не подключен напрямую к Интернету, укажите прокси-сервер, который может использовать компьютер, отличный от Azure. ProxyServerProperties
region Расположение, в котором будут храниться метаданные компьютеров. строка
имя_группы_ресурсов Имя группы ресурсов, в которой подключены соединители Arc (гибридные вычисления). строка
servicePrincipal Объект для доступа к ресурсам, защищенным клиентом Azure AD. ServicePrincipalProperties

ProxyServerProperties

Имя Описание Значение
ip IP-адрес прокси-сервера строка
порт Порт прокси-сервера строка

ServicePrincipalProperties

Имя Описание Значение
applicationId Идентификатор приложения субъекта-службы. строка
secret Строка секрета, которую приложение использует для подтверждения своей личности, также может называться паролем приложения (только для записи). строка

Определение ресурса шаблона ARM

Тип ресурса соединителей можно развернуть с помощью операций, предназначенных для:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.Security/connectors, добавьте следующий код JSON в шаблон.

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

Объекты AuthenticationDetailsProperties

Задайте свойство authenticationType , чтобы указать тип объекта .

Для awsAssumeRole используйте:

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

Для awsCreds используйте:

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

Для gcpCredentials используйте:

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

Значения свойств

соединители

Имя Описание Значение
тип Тип ресурса Microsoft.Security/connectors
версия_API Версия API ресурсов '01.01.2020-preview'
name имя ресурса. строка (обязательно)

Ограничение символов: 1–260

Допустимые символы:
Буквенно-цифровые символы, символы подчеркивания и дефисы.
properties Данные параметров соединителя ConnectorSettingProperties

ConnectorSettingProperties

Имя Описание Значение
authenticationDetails Параметры управления проверкой подлинности. Эти параметры относятся только к облачному соединителю. AuthenticationDetailsProperties
hybridComputeSettings Параметры для управления гибридными вычислениями. Эти параметры применимы только для автоматической подготовки Arc (гибридных вычислений). HybridComputeSettingsProperties

AuthenticationDetailsProperties

Имя Описание Значение
grantedPermissions Разрешения, обнаруженные в облачной учетной записи. Массив строк, содержащий любой из:
AWS::AWSSecurityHubReadOnlyAccess
AWS::AmazonSSMAutomationRole
AWS::SecurityAudit
'GCP::Security Center Администратор Viewer'
authenticationType Установка типа объекта awsAssumeRole
awsCreds
gcpCredentials (обязательно)

AwAssumeRoleAuthenticationDetailsProperties

Имя Описание Значение
authenticationType Подключитесь к облачной учетной записи для AWS используйте учетные данные учетной записи или проверку подлинности на основе ролей. Для GCP используйте учетные данные организации. awsAssumeRole (обязательно)
awsAssumeRoleArn Идентификатор принятой роли — это идентификатор, который можно использовать для создания временных учетных данных безопасности. строка (обязательно)
awsExternalId Уникальный идентификатор, который требуется, если вы принимаете роль в другой учетной записи. строка (обязательно)

AwsCredsAuthenticationDetailsProperties

Имя Описание Значение
authenticationType Подключитесь к облачной учетной записи для AWS используйте учетные данные учетной записи или проверку подлинности на основе ролей. Для GCP используйте учетные данные организации. awsCreds (обязательно)
awsAccessKeyId Элемент открытого ключа объекта учетных данных AWS (только для записи) строка (обязательно)
awsSecretAccessKey Элемент secret key объекта учетных данных AWS (только запись) строка (обязательно)

GcpCredentialsDetailsProperties

Имя Описание Значение
authenticationType Подключитесь к облачной учетной записи для AWS используйте учетные данные учетной записи или проверку подлинности на основе ролей. Для GCP используйте учетные данные организации. 'gcpCredentials' (обязательно)
authProviderX509CertUrl Поле URL-адреса сертификата x509 поставщика проверки подлинности ключа API (только для записи) строка (обязательно)
authUri Поле URI проверки подлинности ключа API (только для записи) строка (обязательно)
clientEmail Поле электронной почты клиента ключа API (только для записи) строка (обязательно)
clientid Поле идентификатора клиента ключа API (только для записи) строка (обязательно)
clientX509CertUrl Поле URL-адреса сертификата x509 клиента ключа API (только для записи) строка (обязательно)
organizationId Идентификатор организации облачной учетной записи GCP строка (обязательно)
privateKey Поле закрытого ключа API (только для записи) строка (обязательно)
privateKeyId Поле идентификатора закрытого ключа API (только запись) строка (обязательно)
projectId Поле Идентификатор проекта ключа API (только для записи) строка (обязательно)
tokenUri Поле URI маркера ключа API (только для записи) строка (обязательно)
тип Поле Type ключа API (только для записи) строка (обязательно)

HybridComputeSettingsProperties

Имя Описание Значение
autoProvision Указывает, следует ли автоматически устанавливать агенты Azure Arc (гибридные вычислительные ресурсы) на компьютерах "Выкл."
"Включено" (обязательно)
proxyServer Для компьютера, отличного от Azure, который не подключен напрямую к Интернету, укажите прокси-сервер, который может использовать компьютер, отличный от Azure. ProxyServerProperties
region Расположение, в котором будут храниться метаданные компьютеров. строка
имя_группы_ресурсов Имя группы ресурсов, в которой подключены соединители Arc (гибридные вычисления). строка
servicePrincipal Объект для доступа к ресурсам, защищенным клиентом Azure AD. ServicePrincipalProperties

ProxyServerProperties

Имя Описание Значение
ip IP-адрес прокси-сервера строка
порт Порт прокси-сервера строка

ServicePrincipalProperties

Имя Описание Значение
applicationId Идентификатор приложения субъекта-службы. строка
secret Строка секрета, которую приложение использует для подтверждения своей личности, также может называться паролем приложения (только для записи). строка

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса соединителей можно развернуть с помощью операций, предназначенных для:

  • Подписки

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.Security/connectors, добавьте в шаблон следующую terraform.

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

Объекты AuthenticationDetailsProperties

Задайте свойство authenticationType , чтобы указать тип объекта .

Для awsAssumeRole используйте:

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

Для awsCreds используйте:

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

Для gcpCredentials используйте:

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

Значения свойств

соединители

Имя Описание Значение
тип Тип ресурса "Microsoft.Security/connectors@2020-01-01-preview"
name имя ресурса. строка (обязательно)

Ограничение символов: 1–260

Допустимые символы:
Буквенно-цифровые символы, символы подчеркивания и дефисы.
parent_id Чтобы выполнить развертывание в подписке, используйте идентификатор этой подписки. строка (обязательно)
properties Данные параметров соединителя ConnectorSettingProperties

ConnectorSettingProperties

Имя Описание Значение
authenticationDetails Параметры управления проверкой подлинности. Эти параметры относятся только к облачному соединителю. AuthenticationDetailsProperties
hybridComputeSettings Параметры для управления гибридными вычислениями. Эти параметры применимы только для автоматической подготовки Arc (гибридных вычислений). HybridComputeSettingsProperties

AuthenticationDetailsProperties

Имя Описание Значение
grantedPermissions Разрешения, обнаруженные в облачной учетной записи. Массив строк, содержащий любой из:
"AWS::AWSSecurityHubReadOnlyAccess"
AWS::AmazonSSMAutomationRole
"AWS::SecurityAudit"
"GCP::Security Center Администратор Viewer"
authenticationType Установка типа объекта awsAssumeRole
awsCreds
gcpCredentials (обязательно)

AwAssumeRoleAuthenticationDetailsProperties

Имя Описание Значение
authenticationType Подключитесь к облачной учетной записи для AWS используйте учетные данные учетной записи или проверку подлинности на основе ролей. Для GCP используйте учетные данные организации. "awsAssumeRole" (обязательно)
awsAssumeRoleArn Идентификатор принятой роли — это идентификатор, который можно использовать для создания временных учетных данных безопасности. строка (обязательно)
awsExternalId Уникальный идентификатор, который требуется, если вы принимаете роль в другой учетной записи. строка (обязательно)

AwsCredsAuthenticationDetailsProperties

Имя Описание Значение
authenticationType Подключитесь к облачной учетной записи для AWS используйте учетные данные учетной записи или проверку подлинности на основе ролей. Для GCP используйте учетные данные организации. awsCreds (обязательно)
awsAccessKeyId Элемент открытого ключа объекта учетных данных AWS (только для записи) строка (обязательно)
awsSecretAccessKey Элемент secret key объекта учетных данных AWS (только запись) строка (обязательно)

GcpCredentialsDetailsProperties

Имя Описание Значение
authenticationType Подключитесь к облачной учетной записи для AWS используйте учетные данные учетной записи или проверку подлинности на основе ролей. Для GCP используйте учетные данные организации. "gcpCredentials" (обязательно)
authProviderX509CertUrl Поле URL-адреса сертификата x509 поставщика проверки подлинности ключа API (только для записи) строка (обязательно)
authUri Поле URI проверки подлинности ключа API (только для записи) строка (обязательно)
clientEmail Поле электронной почты клиента ключа API (только для записи) строка (обязательно)
clientid Поле идентификатора клиента ключа API (только для записи) строка (обязательно)
clientX509CertUrl Поле URL-адреса сертификата x509 клиента ключа API (только для записи) строка (обязательно)
organizationId Идентификатор организации облачной учетной записи GCP строка (обязательно)
privateKey Поле закрытого ключа API (только для записи) строка (обязательно)
privateKeyId Поле идентификатора закрытого ключа API (только запись) строка (обязательно)
projectId Поле Идентификатор проекта ключа API (только для записи) строка (обязательно)
tokenUri Поле URI маркера ключа API (только для записи) строка (обязательно)
тип Поле Type ключа API (только для записи) строка (обязательно)

HybridComputeSettingsProperties

Имя Описание Значение
autoProvision Указывает, следует ли автоматически устанавливать агенты Azure Arc (гибридные вычислительные ресурсы) на компьютерах "Выкл."
"Включено" (обязательно)
proxyServer Для компьютера, отличного от Azure, который не подключен напрямую к Интернету, укажите прокси-сервер, который может использовать компьютер, отличный от Azure. ProxyServerProperties
region Расположение, в котором будут храниться метаданные компьютеров. строка
имя_группы_ресурсов Имя группы ресурсов, в которой подключены соединители Arc (гибридные вычисления). строка
servicePrincipal Объект для доступа к ресурсам, защищенным клиентом Azure AD. ServicePrincipalProperties

ProxyServerProperties

Имя Описание Значение
ip IP-адрес прокси-сервера строка
порт Порт прокси-сервера строка

ServicePrincipalProperties

Имя Описание Значение
applicationId Идентификатор приложения субъекта-службы. строка
secret Строка секрета, которую приложение использует для подтверждения своей личности, также может называться паролем приложения (только для записи). строка