Поделиться через


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

Определение ресурсов Bicep

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

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

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

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

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

Объекты 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/соединители

Имя Описание Ценность
имя Имя ресурса строка (обязательно)
свойства Данные о настройке соединителя connectorSettingProperties
scope Используется при создании ресурса в области, отличной от области развертывания. Задайте для этого свойства символьное имя ресурса, чтобы применить ресурс расширения.

AuthenticationDetailsProperties

Имя Описание Ценность
тип аутентификации Установите значение awsAssumeRole для типа AwAssumeRoleAuthenticationDetailsProperties. Установите значение awsCreds для типа AwsCredsAuthenticationDetailsProperties. Задайте для типа gcpCredentials GcpCredentialsDetailsProperties. "awsAssumeRole"
AwsCreds
"gcpCredentials" (обязательный)

AwAssumeRoleAuthenticationDetailsProperties

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

Свойства AwsCredsAuthenticationDetails

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

Свойства ConnectorSettingProperties

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

GcpCredentialsDetailsProperties

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

HybridComputeSettingsProperties

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

Свойства прокси-сервера

Имя Описание Ценность
протокол IP IP-адрес прокси-сервера струна
порт Порт прокси-сервера струна

ServicePrincipalProperties

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

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

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

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

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

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

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

Объекты 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/соединители

Имя Описание Ценность
apiVersion Версия API «2020-01-01-превью»
имя Имя ресурса строка (обязательно)
свойства Данные о настройке соединителя connectorSettingProperties
тип Тип ресурса "Microsoft.Security/connectors"

AuthenticationDetailsProperties

Имя Описание Ценность
тип аутентификации Установите значение awsAssumeRole для типа AwAssumeRoleAuthenticationDetailsProperties. Установите значение awsCreds для типа AwsCredsAuthenticationDetailsProperties. Задайте для типа gcpCredentials GcpCredentialsDetailsProperties. "awsAssumeRole"
AwsCreds
"gcpCredentials" (обязательный)

AwAssumeRoleAuthenticationDetailsProperties

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

Свойства AwsCredsAuthenticationDetails

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

Свойства ConnectorSettingProperties

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

GcpCredentialsDetailsProperties

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

HybridComputeSettingsProperties

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

Свойства прокси-сервера

Имя Описание Ценность
протокол IP IP-адрес прокси-сервера струна
порт Порт прокси-сервера струна

ServicePrincipalProperties

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

Примеры использования

Определение ресурса 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 = {
    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"
        }
      }
    }
  }
}

Объекты 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/соединители

Имя Описание Ценность
имя Имя ресурса строка (обязательно)
parent_id Идентификатор ресурса для применения этого ресурса расширения. строка (обязательно)
свойства Данные о настройке соединителя connectorSettingProperties
тип Тип ресурса "Microsoft.Security/connectors@2020-01-01-preview"

AuthenticationDetailsProperties

Имя Описание Ценность
тип аутентификации Установите значение awsAssumeRole для типа AwAssumeRoleAuthenticationDetailsProperties. Установите значение awsCreds для типа AwsCredsAuthenticationDetailsProperties. Задайте для типа gcpCredentials GcpCredentialsDetailsProperties. "awsAssumeRole"
AwsCreds
"gcpCredentials" (обязательный)

AwAssumeRoleAuthenticationDetailsProperties

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

Свойства AwsCredsAuthenticationDetails

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

Свойства ConnectorSettingProperties

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

GcpCredentialsDetailsProperties

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

HybridComputeSettingsProperties

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

Свойства прокси-сервера

Имя Описание Ценность
протокол IP IP-адрес прокси-сервера струна
порт Порт прокси-сервера струна

ServicePrincipalProperties

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