Microsoft.SecurityInsights sourcecontrols 2022-10-01-preview

  • Artykuł

Definicja zasobu Bicep

Typ zasobu sourcecontrols to zasób rozszerzenia, co oznacza, że można go zastosować do innego zasobu.

scope Użyj właściwości tego zasobu, aby ustawić zakres dla tego zasobu. Zobacz Ustawianie zakresu dla zasobów rozszerzeń w środowisku Bicep.

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

Format zasobu

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

resource symbolicname 'Microsoft.SecurityInsights/sourcecontrols@2022-10-01-preview' = {
  name: 'string'
  scope: resourceSymbolicName
  etag: 'string'
  properties: {
    contentTypes: [
      'string'
    ]
    description: 'string'
    displayName: 'string'
    id: 'string'
    lastDeploymentInfo: {
      deployment: {
        deploymentId: 'string'
        deploymentLogsUrl: 'string'
        deploymentResult: 'string'
        deploymentState: 'string'
        deploymentTime: 'string'
      }
      deploymentFetchStatus: 'string'
      message: 'string'
    }
    repository: {
      branch: 'string'
      deploymentLogsUrl: 'string'
      displayUrl: 'string'
      pathMapping: [
        {
          contentType: 'string'
          path: 'string'
        }
      ]
      url: 'string'
    }
    repositoryResourceInfo: {
      azureDevOpsResourceInfo: {
        pipelineId: 'string'
        serviceConnectionId: 'string'
      }
      gitHubResourceInfo: {
        appInstallationId: 'string'
      }
      webhook: {
        rotateWebhookSecret: bool
        webhookId: 'string'
        webhookSecretUpdateTime: 'string'
        webhookUrl: 'string'
      }
    }
    repoType: 'string'
    version: 'string'
  }
}

Wartości właściwości

kontrole źródła

Nazwa Opis Wartość
name Nazwa zasobu ciąg (wymagany)
scope Użyj polecenia podczas tworzenia zasobu rozszerzenia w zakresie innym niż zakres wdrożenia. Zasób docelowy

W przypadku elementu Bicep ustaw tę właściwość na symboliczną nazwę zasobu, aby zastosować zasób rozszerzenia.
Etag Etag zasobu platformy Azure ciąg
properties właściwości kontroli źródła SourceControlProperties

SourceControlProperties

Nazwa Opis Wartość
contentTypes Tablica typów zawartości kontroli źródła. Tablica ciągów zawierająca dowolną z:
"AnalyticRule"
"Skoroszyt" (wymagany)
description (opis) Opis kontroli źródła ciąg
displayName Nazwa wyświetlana kontroli źródła ciąg (wymagany)
identyfikator Identyfikator (identyfikator GUID) kontroli źródła ciąg
lastDeploymentInfo Informacje dotyczące najnowszego wdrożenia kontroli źródła. Informacje o wdrożeniu
repozytorium Metadane repozytorium. Repozytorium (wymagane)
repositoryResourceInfo Informacje dotyczące zasobów utworzonych w repozytorium użytkownika. RepositoryResourceInfo
repoType Typ repozytorium kontroli źródła "DevOps"
"Github" (wymagane)
Wersja Numer wersji skojarzony z kontrolą źródła "V1"
"V2"

Informacje o wdrożeniu

Nazwa Opis Wartość
wdrożenie Informacje o wdrożeniu. Wdrożenie
deploymentFetchStatus Stan podczas pobierania ostatniego wdrożenia. "NotFound"
'Success'
"Brak autoryzacji"
message Dodatkowe szczegóły dotyczące wdrożenia, które można wyświetlić użytkownikowi. ciąg

Wdrożenie

Nazwa Opis Wartość
deploymentId Identyfikator wdrożenia. ciąg
deploymentLogsUrl Adres URL umożliwiający dostęp do dzienników akcji repozytorium. ciąg
deploymentResult Wynik wdrożenia. "Anulowano"
"Niepowodzenie"
'Success'
deploymentState Bieżący stan wdrożenia. "Anulowanie"
"Ukończono"
"In_Progress"
"W kolejce"
deploymentTime Czas zakończenia wdrożenia. ciąg

Repozytorium

Nazwa Opis Wartość
oddział Nazwa gałęzi repozytorium. ciąg
deploymentLogsUrl Adres URL umożliwiający dostęp do dzienników akcji repozytorium. ciąg
displayUrl Wyświetl adres URL repozytorium. ciąg
pathMapping Słownik typu zawartości kontroli źródła i mapowania ścieżek. ContentPathMap[]
url Adres URL repozytorium. ciąg

ContentPathMap

Nazwa Opis Wartość
Contenttype Typ zawartości. "AnalyticRule"
"Skoroszyt"
path Ścieżka do zawartości. ciąg

RepositoryResourceInfo

Nazwa Opis Wartość
azureDevOpsResourceInfo Zasoby utworzone w usłudze Azure DevOps dla tej kontroli źródła. AzureDevOpsResourceInfo
gitHubResourceInfo Zasoby utworzone w usłudze GitHub dla tej kontroli źródła. GitHubResourceInfo
element webhook Obiekt elementu webhook utworzony na potrzeby kontroli źródła. Element webhook

AzureDevOpsResourceInfo

Nazwa Opis Wartość
pipelineId Identyfikator potoku utworzonego dla kontroli źródła. ciąg
serviceConnectionId Identyfikator połączenia usługi utworzonego dla kontroli źródła. ciąg

GitHubResourceInfo

Nazwa Opis Wartość
appInstallationId Identyfikator instalacji aplikacji usługi GitHub. ciąg

Webhook

Nazwa Opis Wartość
rotateWebhookSecret Flaga, która nakazuje usłudze zaplecza obracanie wpisu tajnego elementu webhook. bool
webhookId Unikatowy identyfikator elementu webhook. ciąg
webhookSecretUpdateTime Czas aktualizacji wpisu tajnego elementu webhook. ciąg
element webhookUrl Adres URL wywoływany przez element webhook. ciąg

Definicja zasobu szablonu usługi ARM

Typ zasobu sourcecontrols to zasób rozszerzenia, co oznacza, że można go zastosować do innego zasobu.

scope Użyj właściwości tego zasobu, aby ustawić zakres dla tego zasobu. Zobacz Ustawianie zakresu dla zasobów rozszerzeń w szablonach usługi ARM.

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

Format zasobu

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

{
  "type": "Microsoft.SecurityInsights/sourcecontrols",
  "apiVersion": "2022-10-01-preview",
  "name": "string",
  "scope": "string",
  "etag": "string",
  "properties": {
    "contentTypes": [ "string" ],
    "description": "string",
    "displayName": "string",
    "id": "string",
    "lastDeploymentInfo": {
      "deployment": {
        "deploymentId": "string",
        "deploymentLogsUrl": "string",
        "deploymentResult": "string",
        "deploymentState": "string",
        "deploymentTime": "string"
      },
      "deploymentFetchStatus": "string",
      "message": "string"
    },
    "repository": {
      "branch": "string",
      "deploymentLogsUrl": "string",
      "displayUrl": "string",
      "pathMapping": [
        {
          "contentType": "string",
          "path": "string"
        }
      ],
      "url": "string"
    },
    "repositoryResourceInfo": {
      "azureDevOpsResourceInfo": {
        "pipelineId": "string",
        "serviceConnectionId": "string"
      },
      "gitHubResourceInfo": {
        "appInstallationId": "string"
      },
      "webhook": {
        "rotateWebhookSecret": "bool",
        "webhookId": "string",
        "webhookSecretUpdateTime": "string",
        "webhookUrl": "string"
      }
    },
    "repoType": "string",
    "version": "string"
  }
}

Wartości właściwości

kontrola źródła

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.SecurityInsights/sourcecontrols"
apiVersion Wersja interfejsu API zasobów "2022-10-01-preview"
name Nazwa zasobu ciąg (wymagany)
scope Użyj polecenia podczas tworzenia zasobu rozszerzenia w zakresie innym niż zakres wdrożenia. Zasób docelowy

W przypadku formatu JSON ustaw wartość na pełną nazwę zasobu, aby zastosować zasób rozszerzenia do.
Etag Etag zasobu platformy Azure ciąg
properties właściwości kontroli źródła SourceControlProperties

SourceControlProperties

Nazwa Opis Wartość
contentTypes Tablica typów zawartości kontroli źródła. Tablica ciągów zawierająca dowolną z:
"Reguła analityczna"
"Skoroszyt" (wymagany)
description (opis) Opis kontroli źródła ciąg
displayName Nazwa wyświetlana kontrolki źródła ciąg (wymagany)
identyfikator Identyfikator (identyfikator GUID) kontroli źródła ciąg
lastDeploymentInfo Informacje dotyczące najnowszego wdrożenia kontroli źródła. Informacje o wdrożeniu
repozytorium Metadane repozytorium. Repozytorium (wymagane)
repositoryResourceInfo Informacje dotyczące zasobów utworzonych w repozytorium użytkownika. RepositoryResourceInfo
repoType Typ repozytorium kontroli źródła "DevOps"
"Github" (wymagane)
Wersja Numer wersji skojarzony z kontrolą źródła "V1"
"V2"

Informacje o wdrożeniu

Nazwa Opis Wartość
wdrożenie Informacje o wdrożeniu. Wdrożenie
deploymentFetchStatus Stan podczas pobierania ostatniego wdrożenia. "NotFound"
'Success'
"Brak autoryzacji"
message Dodatkowe szczegóły dotyczące wdrożenia, które można wyświetlić użytkownikowi. ciąg

Wdrożenie

Nazwa Opis Wartość
identyfikator wdrożenia Identyfikator wdrożenia. ciąg
deploymentLogsUrl Adres URL umożliwiający dostęp do dzienników akcji repozytorium. ciąg
deploymentResult Wynik wdrożenia. "Anulowano"
"Niepowodzenie"
'Success'
deploymentState Bieżący stan wdrożenia. "Anulowanie"
"Ukończono"
"In_Progress"
"W kolejce"
deploymentTime Czas zakończenia wdrożenia. ciąg

Repozytorium

Nazwa Opis Wartość
oddział Nazwa gałęzi repozytorium. ciąg
deploymentLogsUrl Adres URL umożliwiający dostęp do dzienników akcji repozytorium. ciąg
displayUrl Wyświetl adres URL repozytorium. ciąg
pathMapping Słownik typu zawartości kontroli źródła i mapowania ścieżki. ContentPathMap[]
url Adres URL repozytorium. ciąg

ContentPathMap

Nazwa Opis Wartość
Contenttype Typ zawartości. "Reguła analityczna"
"Skoroszyt"
path Ścieżka do zawartości. ciąg

RepositoryResourceInfo

Nazwa Opis Wartość
azureDevOpsResourceInfo Zasoby utworzone w usłudze Azure DevOps dla tej kontroli źródła. AzureDevOpsResourceInfo
gitHubResourceInfo Zasoby utworzone w usłudze GitHub dla tej kontroli źródła. GitHubResourceInfo
element webhook Obiekt elementu webhook utworzony na potrzeby kontroli źródła. Element webhook

AzureDevOpsResourceInfo

Nazwa Opis Wartość
pipelineId Identyfikator potoku utworzonego dla kontroli źródła. ciąg
serviceConnectionId Identyfikator połączenia usługi utworzonego dla kontroli źródła. ciąg

GitHubResourceInfo

Nazwa Opis Wartość
appInstallationId Identyfikator instalacji aplikacji usługi GitHub. ciąg

Webhook

Nazwa Opis Wartość
rotateWebhookSecret Flaga nakazująca usłudze zaplecza obracanie wpisu tajnego elementu webhook. bool
webhookId Unikatowy identyfikator elementu webhook. ciąg
webhookSecretUpdateTime Czas aktualizacji wpisu tajnego elementu webhook. ciąg
element webhookUrl Adres URL wywoływany przez element webhook. ciąg

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu sourcecontrols to zasób rozszerzenia, co oznacza, że można zastosować go do innego zasobu.

parent_id Użyj właściwości w tym zasobie, aby ustawić zakres dla tego zasobu.

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

Format zasobu

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SecurityInsights/sourcecontrols@2022-10-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      contentTypes = [
        "string"
      ]
      description = "string"
      displayName = "string"
      id = "string"
      lastDeploymentInfo = {
        deployment = {
          deploymentId = "string"
          deploymentLogsUrl = "string"
          deploymentResult = "string"
          deploymentState = "string"
          deploymentTime = "string"
        }
        deploymentFetchStatus = "string"
        message = "string"
      }
      repository = {
        branch = "string"
        deploymentLogsUrl = "string"
        displayUrl = "string"
        pathMapping = [
          {
            contentType = "string"
            path = "string"
          }
        ]
        url = "string"
      }
      repositoryResourceInfo = {
        azureDevOpsResourceInfo = {
          pipelineId = "string"
          serviceConnectionId = "string"
        }
        gitHubResourceInfo = {
          appInstallationId = "string"
        }
        webhook = {
          rotateWebhookSecret = bool
          webhookId = "string"
          webhookSecretUpdateTime = "string"
          webhookUrl = "string"
        }
      }
      repoType = "string"
      version = "string"
    }
    etag = "string"
  })
}

Wartości właściwości

kontrola źródła

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.SecurityInsights/sourcecontrols@2022-10-01-preview"
name Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, do który ma być stosowany ten zasób rozszerzenia. ciąg (wymagany)
Etag Etag zasobu platformy Azure ciąg
properties właściwości kontroli źródła SourceControlProperties

SourceControlProperties

Nazwa Opis Wartość
contentTypes Tablica typów zawartości kontroli źródła. Tablica ciągów zawierająca dowolną z:
"Reguła analityczna"
"Skoroszyt" (wymagany)
description (opis) Opis kontroli źródła ciąg
displayName Nazwa wyświetlana kontrolki źródła ciąg (wymagany)
identyfikator Identyfikator (identyfikator GUID) kontroli źródła ciąg
lastDeploymentInfo Informacje dotyczące najnowszego wdrożenia kontroli źródła. Informacje o wdrożeniu
repozytorium Metadane repozytorium. Repozytorium (wymagane)
repositoryResourceInfo Informacje dotyczące zasobów utworzonych w repozytorium użytkownika. RepositoryResourceInfo
repoType Typ repozytorium kontroli źródła "DevOps"
"Github" (wymagane)
Wersja Numer wersji skojarzony z kontrolą źródła "V1"
"Wersja 2"

Informacje o wdrożeniu

Nazwa Opis Wartość
wdrożenie Informacje o wdrożeniu. Wdrożenie
deploymentFetchStatus Stan podczas pobierania ostatniego wdrożenia. "Nie znaleziono"
"Sukces"
"Brak autoryzacji"
message Dodatkowe szczegóły dotyczące wdrożenia, które można wyświetlić użytkownikowi. ciąg

Wdrożenie

Nazwa Opis Wartość
identyfikator wdrożenia Identyfikator wdrożenia. ciąg
deploymentLogsUrl Adres URL umożliwiający dostęp do dzienników akcji repozytorium. ciąg
deploymentResult Wynik wdrożenia. "Anulowano"
"Niepowodzenie"
"Sukces"
deploymentState Bieżący stan wdrożenia. "Anulowanie"
"Ukończono"
"In_Progress"
"W kolejce"
deploymentTime Czas zakończenia wdrożenia. ciąg

Repozytorium

Nazwa Opis Wartość
oddział Nazwa gałęzi repozytorium. ciąg
deploymentLogsUrl Adres URL umożliwiający dostęp do dzienników akcji repozytorium. ciąg
displayUrl Wyświetl adres URL repozytorium. ciąg
pathMapping Słownik typu zawartości kontroli źródła i mapowania ścieżki. ContentPathMap[]
url Adres URL repozytorium. ciąg

ContentPathMap

Nazwa Opis Wartość
Contenttype Typ zawartości. "AnalyticRule"
"Skoroszyt"
path Ścieżka do zawartości. ciąg

RepositoryResourceInfo

Nazwa Opis Wartość
azureDevOpsResourceInfo Zasoby utworzone w usłudze Azure DevOps dla tej kontroli źródła. AzureDevOpsResourceInfo
gitHubResourceInfo Zasoby utworzone w usłudze GitHub dla tej kontroli źródła. GitHubResourceInfo
element webhook Obiekt elementu webhook utworzony na potrzeby kontroli źródła. Element webhook

AzureDevOpsResourceInfo

Nazwa Opis Wartość
pipelineId Identyfikator potoku utworzonego dla kontroli źródła. ciąg
serviceConnectionId Identyfikator połączenia usługi utworzonego dla kontroli źródła. ciąg

GitHubResourceInfo

Nazwa Opis Wartość
appInstallationId Identyfikator instalacji aplikacji usługi GitHub. ciąg

Webhook

Nazwa Opis Wartość
rotateWebhookSecret Flaga, która nakazuje usłudze zaplecza obracanie wpisu tajnego elementu webhook. bool
webhookId Unikatowy identyfikator elementu webhook. ciąg
webhookSecretUpdateTime Czas aktualizacji wpisu tajnego elementu webhook. ciąg
element webhookUrl Adres URL wywoływany przez element webhook. ciąg