你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.SecurityInsights sourcecontrols 2022-09-01-preview

Bicep 资源定义

sourcecontrols 资源类型是 扩展资源,这意味着你可以将其应用于其他资源。

scope使用此资源上的 属性可设置此资源的范围。 请参阅 在 Bicep 中设置扩展资源的范围

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.SecurityInsights/sourcecontrols 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.SecurityInsights/sourcecontrols@2022-09-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'
  }
}

属性值

sourcecontrols

名称 说明
name 资源名称 字符串 (必需)
scope 在与部署范围不同的范围创建扩展资源时使用 。 目标资源

对于 Bicep,请将此属性设置为资源的符号名称以应用 扩展资源
etag Azure 资源的 Etag string
properties 源代码管理属性 SourceControlProperties

SourceControlProperties

名称 说明
contentTypes 源代码管理内容类型的数组。 包含任意项的字符串数组:
“AnalyticRule”
“Workbook” (必需)
description 源代码管理的说明 string
displayName 源代码控件的显示名称 字符串 (必需)
id (源代码管理 guid) 的 ID string
lastDeploymentInfo 有关源代码管理的最新部署的信息。 DeploymentInfo
repository 存储库元数据。 存储库 (必需)
repositoryResourceInfo 有关在用户存储库中创建的资源的信息。 RepositoryResourceInfo
repoType 源代码管理的存储库类型 “DevOps”
“Github” (必需)
版本 与源代码管理关联的版本号 “V1”
“V2”

DeploymentInfo

名称 说明
部署 部署信息。 部署
deploymentFetchStatus 提取上次部署时的状态。 “NotFound”
“Success”
“未授权”
message 可向用户显示有关部署的其他详细信息。 string

部署

名称 说明
deploymentId 部署标识符。 string
deploymentLogsUrl 用于访问存储库操作日志的 URL。 string
deploymentResult 部署的结果。 “已取消”
“Failed”
“Success”
deploymentState 部署的当前状态。 “正在取消”
“Completed”
“In_Progress”
“Queued”
deploymentTime 部署完成的时间。 string

存储库

名称 说明
branch 存储库的分支名称。 string
deploymentLogsUrl 用于访问存储库操作日志的 URL。 string
displayUrl 显示存储库的 URL。 string
pathMapping 源代码管理内容类型和路径映射的字典。 ContentPathMap[]
url 存储库的 URL。 string

ContentPathMap

名称 说明
contentType 内容类型。 “AnalyticRule”
“Workbook”
path 内容的路径。 string

RepositoryResourceInfo

名称 说明
azureDevOpsResourceInfo 在 Azure DevOps 中为此源代码管理创建的资源。 AzureDevOpsResourceInfo
gitHubResourceInfo 在 GitHub 中为此源代码管理创建的资源。 GitHubResourceInfo
webhook 为源代码管理创建的 Webhook 对象。 Webhook

AzureDevOpsResourceInfo

名称 说明
pipelineId 为源代码管理创建的管道的 ID。 string
serviceConnectionId 为源代码管理创建的服务连接的 ID。 string

GitHubResourceInfo

名称 说明
appInstallationId GitHub 应用程序安装 ID。 string

Webhook

名称 说明
rotateWebhookSecret 指示后端服务轮换 Webhook 机密的标志。 bool
webhookId Webhook 的唯一标识符。 string
webhookSecretUpdateTime 更新 Webhook 机密的时间。 string
webhookUrl Webhook 调用的 URL。 string

ARM 模板资源定义

sourcecontrols 资源类型是 扩展资源,这意味着你可以将其应用于另一个资源。

scope使用此资源上的 属性可设置此资源的作用域。 请参阅 在 ARM 模板中设置扩展资源的范围

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.SecurityInsights/sourcecontrols 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.SecurityInsights/sourcecontrols",
  "apiVersion": "2022-09-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"
  }
}

属性值

sourcecontrols

名称 说明 Value
type 资源类型 “Microsoft.SecurityInsights/sourcecontrols”
apiVersion 资源 API 版本 '2022-09-01-preview'
name 资源名称 字符串 (必需)
scope 在不同于部署范围的范围创建扩展资源时使用 。 目标资源

对于 JSON,请将值设置为要向其应用 扩展资源的资源 的全名。
etag Azure 资源的 Etag string
properties 源代码管理属性 SourceControlProperties

SourceControlProperties

名称 说明
contentTypes 源代码管理内容类型的数组。 包含任何一项的字符串数组:
“AnalyticRule”
“Workbook” (必需)
description 源代码管理的说明 string
displayName 源代码管理显示名称 字符串 (必需)
id (源代码管理 Guid) 的 ID string
lastDeploymentInfo 有关源代码管理的最新部署的信息。 DeploymentInfo
repository 存储库元数据。 需要存储库 ()
repositoryResourceInfo 有关在用户存储库中创建的资源的信息。 RepositoryResourceInfo
repoType 源代码管理的存储库类型 “DevOps”
需要“Github” ()
版本 与源代码管理关联的版本号 “V1”
“V2”

DeploymentInfo

名称 说明
部署 部署信息。 部署
deploymentFetchStatus 提取最后一个部署时的状态。 “NotFound”
“Success”
“未授权”
message 可向用户显示有关部署的其他详细信息。 string

部署

名称 说明
deploymentId 部署标识符。 string
deploymentLogsUrl 用于访问存储库操作日志的 URL。 string
deploymentResult 部署的结果。 “已取消”
“Failed”
“Success”
deploymentState 部署的当前状态。 “正在取消”
“Completed”
“In_Progress”
“Queued”
deploymentTime 部署完成的时间。 string

存储库

名称 说明
branch 存储库的分支名称。 string
deploymentLogsUrl 用于访问存储库操作日志的 URL。 string
displayUrl 显示存储库的 URL。 string
pathMapping 源代码管理内容类型和路径映射的字典。 ContentPathMap[]
url 存储库的 URL。 string

ContentPathMap

名称 说明
contentType 内容类型。 “AnalyticRule”
“Workbook”
path 内容的路径。 string

RepositoryResourceInfo

名称 说明
azureDevOpsResourceInfo 在 Azure DevOps 中为此源代码管理创建的资源。 AzureDevOpsResourceInfo
gitHubResourceInfo 在 GitHub 中为此源代码管理创建的资源。 GitHubResourceInfo
webhook 为源代码管理创建的 Webhook 对象。 Webhook

AzureDevOpsResourceInfo

名称 说明
pipelineId 为源代码管理创建的管道的 ID。 string
serviceConnectionId 为源代码管理创建的服务连接的 ID。 string

GitHubResourceInfo

名称 说明
appInstallationId GitHub 应用程序安装 ID。 string

Webhook

名称 说明
rotateWebhookSecret 指示后端服务轮换 Webhook 机密的标志。 bool
webhookId Webhook 的唯一标识符。 string
webhookSecretUpdateTime 更新 Webhook 机密的时间。 string
webhookUrl Webhook 调用的 URL。 string

Terraform (AzAPI 提供程序) 资源定义

sourcecontrols 资源类型是 扩展资源,这意味着你可以将其应用于另一个资源。

parent_id使用此资源上的 属性可设置此资源的作用域。

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.SecurityInsights/sourcecontrols 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SecurityInsights/sourcecontrols@2022-09-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"
  })
}

属性值

sourcecontrols

名称 说明 Value
type 资源类型 “Microsoft.SecurityInsights/sourcecontrols@2022-09-01-preview”
name 资源名称 字符串 (必需)
parent_id 要应用此扩展资源的资源的 ID。 字符串 (必需)
etag Azure 资源的 Etag string
properties 源代码管理属性 SourceControlProperties

SourceControlProperties

名称 说明
contentTypes 源代码管理内容类型的数组。 包含任意项的字符串数组:
“AnalyticRule”
“工作簿” (必需的)
description 源代码管理的说明 string
displayName 源代码控件的显示名称 字符串 (必需)
id (源代码管理 guid) 的 ID string
lastDeploymentInfo 有关源代码管理的最新部署的信息。 DeploymentInfo
repository 存储库元数据。 存储库 (必需)
repositoryResourceInfo 有关在用户存储库中创建的资源的信息。 RepositoryResourceInfo
repoType 源代码管理的存储库类型 “DevOps”
“Github” (必需)
版本 与源代码管理关联的版本号 “V1”
“V2”

DeploymentInfo

名称 说明
部署 部署信息。 部署
deploymentFetchStatus 提取上次部署时的状态。 “NotFound”
“Success”
“未授权”
message 可向用户显示有关部署的其他详细信息。 string

部署

名称 说明
deploymentId 部署标识符。 string
deploymentLogsUrl 用于访问存储库操作日志的 URL。 string
deploymentResult 部署的结果。 “已取消”
“失败”
“Success”
deploymentState 部署的当前状态。 “正在取消”
“Completed”
“In_Progress”
“排队”
deploymentTime 部署完成的时间。 string

存储库

名称 说明
branch 存储库的分支名称。 string
deploymentLogsUrl 用于访问存储库操作日志的 URL。 string
displayUrl 显示存储库的 URL。 string
pathMapping 源代码管理内容类型和路径映射的字典。 ContentPathMap[]
url 存储库的 URL。 string

ContentPathMap

名称 说明
contentType 内容类型。 “AnalyticRule”
“Workbook”
path 内容的路径。 string

RepositoryResourceInfo

名称 说明
azureDevOpsResourceInfo 在 Azure DevOps 中为此源代码管理创建的资源。 AzureDevOpsResourceInfo
gitHubResourceInfo 在 GitHub 中为此源代码管理创建的资源。 GitHubResourceInfo
webhook 为源代码管理创建的 Webhook 对象。 Webhook

AzureDevOpsResourceInfo

名称 说明
pipelineId 为源代码管理创建的管道的 ID。 string
serviceConnectionId 为源代码管理创建的服务连接的 ID。 string

GitHubResourceInfo

名称 说明
appInstallationId GitHub 应用程序安装 ID。 string

Webhook

名称 说明
rotateWebhookSecret 指示后端服务轮换 Webhook 机密的标志。 bool
webhookId Webhook 的唯一标识符。 string
webhookSecretUpdateTime 更新 Webhook 机密的时间。 string
webhookUrl Webhook 调用的 URL。 字符串