Udostępnij przez

Łączniki Microsoft.Security

Definicja zasobu Bicep

Typ zasobu łączników można wdrożyć za pomocą operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Security/connectors, dodaj następujący kod Bicep do szablonu.

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, obiekty

Ustaw właściwość authenticationType, aby określić typ obiektu.

W przypadku awsAssumeRoleużyj:

{
  authenticationType: 'awsAssumeRole'
  awsAssumeRoleArn: 'string'
  awsExternalId: 'string'
}

W przypadku awsCredsużyj:

{
  authenticationType: 'awsCreds'
  awsAccessKeyId: 'string'
  awsSecretAccessKey: 'string'
}

W przypadku gcpCredentials użyj:

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

Wartości właściwości

Microsoft.Security/connectors

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Dane ustawień łącznika Właściwości ConnectorSettingProperties
zakres Użyj polecenia podczas tworzenia zasobu w zakresie innym niż zakres wdrożenia. Ustaw tę właściwość na symboliczną nazwę zasobu, aby zastosować zasób rozszerzenia.

AuthenticationDetailsProperties

Nazwa Opis Wartość
Typ uwierzytelniania Ustaw wartość "awsAssumeRole" dla typu AwAssumeRoleAuthenticationDetailsProperties. Ustaw wartość "awsCreds" dla typu AwsCredsAuthenticationDetailsProperties. Ustaw wartość "gcpCredentials" dla typu GcpCredentialsDetailsProperties. "awsAssumeRole"
"awsCreds"
"gcpCredentials" (wymagane)

Właściwości AwAssumeRoleAuthenticationDetailsProperties

Nazwa Opis Wartość
Typ uwierzytelniania Nawiąż połączenie z kontem w chmurze, aby platforma AWS używała poświadczeń konta lub uwierzytelniania opartego na rolach. W przypadku platformy GCP użyj poświadczeń organizacji konta. "awsAssumeRole" (wymagane)
awsAssumeRoleArn Przyjmuje się, że identyfikator roli jest identyfikatorem, którego można użyć do tworzenia tymczasowych poświadczeń zabezpieczeń. ciąg (wymagany)
awsExternalId (identyfikator zewnętrzny) Unikatowy identyfikator wymagany podczas przejmowania roli na innym koncie. ciąg (wymagany)

AwsCredsAuthenticationDetailsProperties

Nazwa Opis Wartość
Typ uwierzytelniania Nawiąż połączenie z kontem w chmurze, aby platforma AWS używała poświadczeń konta lub uwierzytelniania opartego na rolach. W przypadku platformy GCP użyj poświadczeń organizacji konta. "awsCreds" (wymagane)
awsAccessKeyId (identyfikator dostępu) Element klucza publicznego obiektu poświadczeń platformy AWS (tylko zapis) ciąg (wymagany)
awsSecretAccessKey Element klucza tajnego obiektu poświadczeń platformy AWS (tylko zapis) ciąg (wymagany)

Właściwości ConnectorSettingProperties

Nazwa Opis Wartość
authenticationDetails (uwierzytelnianieSzczegóły) Ustawienia zarządzania uwierzytelnianiem są istotne tylko dla łącznika chmury. AuthenticationDetailsProperties
hybridComputeSettings Ustawienia hybrydowego zarządzania obliczeniami. Te ustawienia są istotne tylko w przypadku automatycznej aprowizacji usługi Arc (obliczenia hybrydowe). HybridComputeSettingsProperties

GcpCredentialsDetailsProperties

Nazwa Opis Wartość
Typ uwierzytelniania Nawiąż połączenie z kontem w chmurze, aby platforma AWS używała poświadczeń konta lub uwierzytelniania opartego na rolach. W przypadku platformy GCP użyj poświadczeń organizacji konta. "gcpCredentials" (wymagane)
authProviderX509CertUrl Pole Adres URL certyfikatu x509 dostawcy uwierzytelniania klucza interfejsu API (tylko zapis) ciąg (wymagany)
identyfikator authUri Pole identyfikatora URI uwierzytelniania klucza interfejsu API (tylko zapis) ciąg (wymagany)
clientEmail (klient Poczta E- Pole poczty e-mail klienta klucza interfejsu API (tylko zapis) ciąg (wymagany)
clientId (identyfikator klienta) Pole Identyfikator klienta klucza interfejsu API (tylko zapis) ciąg (wymagany)
clientX509CertUrl clientX509CertUrl Pole Adres URL certyfikatu x509 klienta klucza interfejsu API (tylko zapis) ciąg (wymagany)
identyfikator organizacji Identyfikator organizacji konta chmury GCP ciąg (wymagany)
privateKey (klucz prywatny) Pole klucza prywatnego klucza interfejsu API (tylko zapis) ciąg (wymagany)
privateKeyId (identyfikator klucza prywatnego) Pole Identyfikator klucza prywatnego klucza interfejsu API (tylko zapis) ciąg (wymagany)
identyfikator projektu Pole Identyfikator projektu klucza interfejsu API (tylko zapis) ciąg (wymagany)
tokenUri (identyfikator tokenUri) Pole identyfikatora URI tokenu klucza interfejsu API (tylko zapis) ciąg (wymagany)
typ Wpisz pole klucza interfejsu API (tylko zapis) ciąg (wymagany)

HybridComputeSettingsProperties

Nazwa Opis Wartość
automatyczna aprowizacja Niezależnie od tego, czy automatycznie instalować agentów usługi Azure Arc (hybrydowych obliczeń) na maszynach "Wyłączone"
"Włączone" (wymagane)
serwer proxy W przypadku maszyny spoza platformy Azure, która nie jest połączona bezpośrednio z Internetem, określ serwer proxy, którego może używać maszyna spoza platformy Azure. proxyServerProperties
region Lokalizacja, w której będą przechowywane metadane maszyn ciąg
resourceGroupName (nazwa grupy zasobów) Nazwa grupy zasobów, w której są połączone łączniki usługi Arc (hybrydowe środowisko obliczeniowe). ciąg
servicePrincipal (jednostka usługi) Obiekt umożliwiający dostęp do zasobów zabezpieczonych przez dzierżawę usługi Azure AD. ServicePrincipalProperties (Właściwości usługi)

Właściwości serwera ProxyServerProperties

Nazwa Opis Wartość
Ip Adres IP serwera proxy ciąg
port Port serwera proxy ciąg

ServicePrincipalProperties (Właściwości usługi)

Nazwa Opis Wartość
applicationId (identyfikator aplikacji) Identyfikator aplikacji jednostki usługi. ciąg
klucz tajny Ciąg wpisu tajnego używany przez aplikację do potwierdzenia tożsamości może być również określany jako hasło aplikacji (tylko zapis). ciąg

Definicja zasobu szablonu usługi ARM

Typ zasobu łączników można wdrożyć za pomocą operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Security/connectors, dodaj następujący kod JSON do szablonu.

{
  "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, obiekty

Ustaw właściwość authenticationType, aby określić typ obiektu.

W przypadku awsAssumeRoleużyj:

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

W przypadku awsCredsużyj:

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

W przypadku gcpCredentials użyj:

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

Wartości właściwości

Microsoft.Security/connectors

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) Wersja interfejsu API "2020-01-01-preview"
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Dane ustawień łącznika Właściwości ConnectorSettingProperties
typ Typ zasobu "Microsoft.Security/connectors"

AuthenticationDetailsProperties

Nazwa Opis Wartość
Typ uwierzytelniania Ustaw wartość "awsAssumeRole" dla typu AwAssumeRoleAuthenticationDetailsProperties. Ustaw wartość "awsCreds" dla typu AwsCredsAuthenticationDetailsProperties. Ustaw wartość "gcpCredentials" dla typu GcpCredentialsDetailsProperties. "awsAssumeRole"
"awsCreds"
"gcpCredentials" (wymagane)

Właściwości AwAssumeRoleAuthenticationDetailsProperties

Nazwa Opis Wartość
Typ uwierzytelniania Nawiąż połączenie z kontem w chmurze, aby platforma AWS używała poświadczeń konta lub uwierzytelniania opartego na rolach. W przypadku platformy GCP użyj poświadczeń organizacji konta. "awsAssumeRole" (wymagane)
awsAssumeRoleArn Przyjmuje się, że identyfikator roli jest identyfikatorem, którego można użyć do tworzenia tymczasowych poświadczeń zabezpieczeń. ciąg (wymagany)
awsExternalId (identyfikator zewnętrzny) Unikatowy identyfikator wymagany podczas przejmowania roli na innym koncie. ciąg (wymagany)

AwsCredsAuthenticationDetailsProperties

Nazwa Opis Wartość
Typ uwierzytelniania Nawiąż połączenie z kontem w chmurze, aby platforma AWS używała poświadczeń konta lub uwierzytelniania opartego na rolach. W przypadku platformy GCP użyj poświadczeń organizacji konta. "awsCreds" (wymagane)
awsAccessKeyId (identyfikator dostępu) Element klucza publicznego obiektu poświadczeń platformy AWS (tylko zapis) ciąg (wymagany)
awsSecretAccessKey Element klucza tajnego obiektu poświadczeń platformy AWS (tylko zapis) ciąg (wymagany)

Właściwości ConnectorSettingProperties

Nazwa Opis Wartość
authenticationDetails (uwierzytelnianieSzczegóły) Ustawienia zarządzania uwierzytelnianiem są istotne tylko dla łącznika chmury. AuthenticationDetailsProperties
hybridComputeSettings Ustawienia hybrydowego zarządzania obliczeniami. Te ustawienia są istotne tylko w przypadku automatycznej aprowizacji usługi Arc (obliczenia hybrydowe). HybridComputeSettingsProperties

GcpCredentialsDetailsProperties

Nazwa Opis Wartość
Typ uwierzytelniania Nawiąż połączenie z kontem w chmurze, aby platforma AWS używała poświadczeń konta lub uwierzytelniania opartego na rolach. W przypadku platformy GCP użyj poświadczeń organizacji konta. "gcpCredentials" (wymagane)
authProviderX509CertUrl Pole Adres URL certyfikatu x509 dostawcy uwierzytelniania klucza interfejsu API (tylko zapis) ciąg (wymagany)
identyfikator authUri Pole identyfikatora URI uwierzytelniania klucza interfejsu API (tylko zapis) ciąg (wymagany)
clientEmail (klient Poczta E- Pole poczty e-mail klienta klucza interfejsu API (tylko zapis) ciąg (wymagany)
clientId (identyfikator klienta) Pole Identyfikator klienta klucza interfejsu API (tylko zapis) ciąg (wymagany)
clientX509CertUrl clientX509CertUrl Pole Adres URL certyfikatu x509 klienta klucza interfejsu API (tylko zapis) ciąg (wymagany)
identyfikator organizacji Identyfikator organizacji konta chmury GCP ciąg (wymagany)
privateKey (klucz prywatny) Pole klucza prywatnego klucza interfejsu API (tylko zapis) ciąg (wymagany)
privateKeyId (identyfikator klucza prywatnego) Pole Identyfikator klucza prywatnego klucza interfejsu API (tylko zapis) ciąg (wymagany)
identyfikator projektu Pole Identyfikator projektu klucza interfejsu API (tylko zapis) ciąg (wymagany)
tokenUri (identyfikator tokenUri) Pole identyfikatora URI tokenu klucza interfejsu API (tylko zapis) ciąg (wymagany)
typ Wpisz pole klucza interfejsu API (tylko zapis) ciąg (wymagany)

HybridComputeSettingsProperties

Nazwa Opis Wartość
automatyczna aprowizacja Niezależnie od tego, czy automatycznie instalować agentów usługi Azure Arc (hybrydowych obliczeń) na maszynach "Wyłączone"
"Włączone" (wymagane)
serwer proxy W przypadku maszyny spoza platformy Azure, która nie jest połączona bezpośrednio z Internetem, określ serwer proxy, którego może używać maszyna spoza platformy Azure. proxyServerProperties
region Lokalizacja, w której będą przechowywane metadane maszyn ciąg
resourceGroupName (nazwa grupy zasobów) Nazwa grupy zasobów, w której są połączone łączniki usługi Arc (hybrydowe środowisko obliczeniowe). ciąg
servicePrincipal (jednostka usługi) Obiekt umożliwiający dostęp do zasobów zabezpieczonych przez dzierżawę usługi Azure AD. ServicePrincipalProperties (Właściwości usługi)

Właściwości serwera ProxyServerProperties

Nazwa Opis Wartość
Ip Adres IP serwera proxy ciąg
port Port serwera proxy ciąg

ServicePrincipalProperties (Właściwości usługi)

Nazwa Opis Wartość
applicationId (identyfikator aplikacji) Identyfikator aplikacji jednostki usługi. ciąg
klucz tajny Ciąg wpisu tajnego używany przez aplikację do potwierdzenia tożsamości może być również określany jako hasło aplikacji (tylko zapis). ciąg

Przykłady użycia

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu łączników można wdrożyć za pomocą operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Security/connectors, dodaj następujący program Terraform do szablonu.

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, obiekty

Ustaw właściwość authenticationType, aby określić typ obiektu.

W przypadku awsAssumeRoleużyj:

{
  authenticationType = "awsAssumeRole"
  awsAssumeRoleArn = "string"
  awsExternalId = "string"
}

W przypadku awsCredsużyj:

{
  authenticationType = "awsCreds"
  awsAccessKeyId = "string"
  awsSecretAccessKey = "string"
}

W przypadku gcpCredentials użyj:

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

Wartości właściwości

Microsoft.Security/connectors

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, do który ma być stosowany ten zasób rozszerzenia. ciąg (wymagany)
Właściwości Dane ustawień łącznika Właściwości ConnectorSettingProperties
typ Typ zasobu "Microsoft.Security/connectors@2020-01-01-preview"

AuthenticationDetailsProperties

Nazwa Opis Wartość
Typ uwierzytelniania Ustaw wartość "awsAssumeRole" dla typu AwAssumeRoleAuthenticationDetailsProperties. Ustaw wartość "awsCreds" dla typu AwsCredsAuthenticationDetailsProperties. Ustaw wartość "gcpCredentials" dla typu GcpCredentialsDetailsProperties. "awsAssumeRole"
"awsCreds"
"gcpCredentials" (wymagane)

Właściwości AwAssumeRoleAuthenticationDetailsProperties

Nazwa Opis Wartość
Typ uwierzytelniania Nawiąż połączenie z kontem w chmurze, aby platforma AWS używała poświadczeń konta lub uwierzytelniania opartego na rolach. W przypadku platformy GCP użyj poświadczeń organizacji konta. "awsAssumeRole" (wymagane)
awsAssumeRoleArn Przyjmuje się, że identyfikator roli jest identyfikatorem, którego można użyć do tworzenia tymczasowych poświadczeń zabezpieczeń. ciąg (wymagany)
awsExternalId (identyfikator zewnętrzny) Unikatowy identyfikator wymagany podczas przejmowania roli na innym koncie. ciąg (wymagany)

AwsCredsAuthenticationDetailsProperties

Nazwa Opis Wartość
Typ uwierzytelniania Nawiąż połączenie z kontem w chmurze, aby platforma AWS używała poświadczeń konta lub uwierzytelniania opartego na rolach. W przypadku platformy GCP użyj poświadczeń organizacji konta. "awsCreds" (wymagane)
awsAccessKeyId (identyfikator dostępu) Element klucza publicznego obiektu poświadczeń platformy AWS (tylko zapis) ciąg (wymagany)
awsSecretAccessKey Element klucza tajnego obiektu poświadczeń platformy AWS (tylko zapis) ciąg (wymagany)

Właściwości ConnectorSettingProperties

Nazwa Opis Wartość
authenticationDetails (uwierzytelnianieSzczegóły) Ustawienia zarządzania uwierzytelnianiem są istotne tylko dla łącznika chmury. AuthenticationDetailsProperties
hybridComputeSettings Ustawienia hybrydowego zarządzania obliczeniami. Te ustawienia są istotne tylko w przypadku automatycznej aprowizacji usługi Arc (obliczenia hybrydowe). HybridComputeSettingsProperties

GcpCredentialsDetailsProperties

Nazwa Opis Wartość
Typ uwierzytelniania Nawiąż połączenie z kontem w chmurze, aby platforma AWS używała poświadczeń konta lub uwierzytelniania opartego na rolach. W przypadku platformy GCP użyj poświadczeń organizacji konta. "gcpCredentials" (wymagane)
authProviderX509CertUrl Pole Adres URL certyfikatu x509 dostawcy uwierzytelniania klucza interfejsu API (tylko zapis) ciąg (wymagany)
identyfikator authUri Pole identyfikatora URI uwierzytelniania klucza interfejsu API (tylko zapis) ciąg (wymagany)
clientEmail (klient Poczta E- Pole poczty e-mail klienta klucza interfejsu API (tylko zapis) ciąg (wymagany)
clientId (identyfikator klienta) Pole Identyfikator klienta klucza interfejsu API (tylko zapis) ciąg (wymagany)
clientX509CertUrl clientX509CertUrl Pole Adres URL certyfikatu x509 klienta klucza interfejsu API (tylko zapis) ciąg (wymagany)
identyfikator organizacji Identyfikator organizacji konta chmury GCP ciąg (wymagany)
privateKey (klucz prywatny) Pole klucza prywatnego klucza interfejsu API (tylko zapis) ciąg (wymagany)
privateKeyId (identyfikator klucza prywatnego) Pole Identyfikator klucza prywatnego klucza interfejsu API (tylko zapis) ciąg (wymagany)
identyfikator projektu Pole Identyfikator projektu klucza interfejsu API (tylko zapis) ciąg (wymagany)
tokenUri (identyfikator tokenUri) Pole identyfikatora URI tokenu klucza interfejsu API (tylko zapis) ciąg (wymagany)
typ Wpisz pole klucza interfejsu API (tylko zapis) ciąg (wymagany)

HybridComputeSettingsProperties

Nazwa Opis Wartość
automatyczna aprowizacja Niezależnie od tego, czy automatycznie instalować agentów usługi Azure Arc (hybrydowych obliczeń) na maszynach "Wyłączone"
"Włączone" (wymagane)
serwer proxy W przypadku maszyny spoza platformy Azure, która nie jest połączona bezpośrednio z Internetem, określ serwer proxy, którego może używać maszyna spoza platformy Azure. proxyServerProperties
region Lokalizacja, w której będą przechowywane metadane maszyn ciąg
resourceGroupName (nazwa grupy zasobów) Nazwa grupy zasobów, w której są połączone łączniki usługi Arc (hybrydowe środowisko obliczeniowe). ciąg
servicePrincipal (jednostka usługi) Obiekt umożliwiający dostęp do zasobów zabezpieczonych przez dzierżawę usługi Azure AD. ServicePrincipalProperties (Właściwości usługi)

Właściwości serwera ProxyServerProperties

Nazwa Opis Wartość
Ip Adres IP serwera proxy ciąg
port Port serwera proxy ciąg

ServicePrincipalProperties (Właściwości usługi)

Nazwa Opis Wartość
applicationId (identyfikator aplikacji) Identyfikator aplikacji jednostki usługi. ciąg
klucz tajny Ciąg wpisu tajnego używany przez aplikację do potwierdzenia tożsamości może być również określany jako hasło aplikacji (tylko zapis). ciąg
  • Last updated on