Microsoft.OperationalInsights (stable:2024-03-01)

2025/01/31 • 3 updated methods

SourceControls_List (updated)
Description :  Gets all source controls, without source control items.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SourceControls_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "contentTypes": {
                  "Enum": {
                    "new": [
                      [
                        "AnalyticsRule",
                        ""
                      ],
                      [
                        "AutomationRule",
                        ""
                      ],
                      [
                        "HuntingQuery",
                        ""
                      ],
                      [
                        "Parser",
                        ""
                      ],
                      [
                        "Playbook",
                        ""
                      ],
                      [
                        "Workbook",
                        ""
                      ]
                    ],
                    "old": [
                      [
                        "AnalyticRule",
                        ""
                      ],
                      [
                        "AutomationRule",
                        ""
                      ],
                      [
                        "HuntingQuery",
                        ""
                      ],
                      [
                        "Parser",
                        ""
                      ],
                      [
                        "Playbook",
                        ""
                      ],
                      [
                        "Workbook",
                        ""
                      ]
                    ]
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/sourcecontrols
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to fetch the next set of source controls. ,
Required: False ,
}
string ,
value:
{
Description: Array of source controls. ,
Required: True ,
}
[
{
properties:
{
Description: source control properties ,
Required: True ,
}
{
id:
{
Description: The id (a Guid) of the source control ,
Required: False ,
}
string ,
version:
{
Description: The version number associated with the source control ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the source control ,
Required: True ,
}
string ,
description:
{
Description: A description of the source control ,
Required: False ,
}
string ,
repoType:
{
Description: The repository type of the source control ,
Enum:
{
Github: No description available. ,
AzureDevOps: No description available. ,
}
,
Required: True ,
}
enum ,
contentTypes:
{
Description: Array of source control content types. ,
Required: True ,
}
[
string ,
]
,
repository:
{
Description: Repository metadata. ,
Required: True ,
}
{
url:
{
Description: Url of repository. ,
Required: True ,
}
string ,
branch:
{
Description: Branch name of repository. ,
Required: True ,
}
string ,
displayUrl:
{
Description: Display url of repository. ,
Required: False ,
}
string ,
deploymentLogsUrl:
{
Description: Url to access repository action logs. ,
Required: False ,
}
string ,
}
,
servicePrincipal:
{
Description: Service principal metadata. ,
Required: False ,
}
{
id:
{
Description: Id of service principal. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant id of service principal. ,
Required: False ,
}
string ,
appId:
{
Description: App id of service principal. ,
Required: False ,
}
string ,
credentialsExpireOn:
{
Description: Expiration time of service principal credentials. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
repositoryAccess:
{
Description: Repository access credentials. This is write-only object and it never returns back to a user. ,
Required: False ,
}
{
kind:
{
Description: The kind of repository access credentials ,
Enum:
{
OAuth: No description available. ,
PAT: No description available. ,
App: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: OAuth Code. Required when `kind` is `OAuth` ,
Required: False ,
}
string ,
state:
{
Description: OAuth State. Required when `kind` is `OAuth` ,
Required: False ,
}
string ,
clientId:
{
Description: OAuth ClientId. Required when `kind` is `OAuth` ,
Required: False ,
}
string ,
token:
{
Description: Personal Access Token. Required when `kind` is `PAT` ,
Required: False ,
}
string ,
installationId:
{
Description: Application installation ID. Required when `kind` is `App`. Supported by `GitHub` only. ,
Required: False ,
}
string ,
}
,
repositoryResourceInfo:
{
Description: Information regarding the resources created in user's repository. ,
Required: False ,
}
{
webhook:
{
Description: The webhook object created for the source-control. ,
Required: False ,
}
{
webhookId:
{
Description: Unique identifier for the webhook. ,
Required: False ,
}
string ,
webhookUrl:
{
Description: URL that gets invoked by the webhook. ,
Required: False ,
}
string ,
webhookSecretUpdateTime:
{
Description: Time when the webhook secret was updated. ,
Format: date-time ,
Required: False ,
}
string ,
rotateWebhookSecret:
{
Description: A flag to instruct the backend service to rotate webhook secret. ,
Required: False ,
}
boolean ,
}
,
gitHubResourceInfo:
{
Description: Resources created in GitHub for this source-control. ,
Required: False ,
}
{
appInstallationId:
{
Description: GitHub application installation id. ,
Required: False ,
}
string ,
}
,
azureDevOpsResourceInfo:
{
Description: Resources created in Azure DevOps for this source-control. ,
Required: False ,
}
{
pipelineId:
{
Description: Id of the pipeline created for the source-control. ,
Required: False ,
}
string ,
serviceConnectionId:
{
Description: Id of the service-connection created for the source-control. ,
Required: False ,
}
string ,
}
,
}
,
lastDeploymentInfo:
{
Description: Information regarding the latest deployment for the source control. ,
Required: False ,
}
{
deploymentFetchStatus:
{
Description: Status while fetching the last deployment. ,
Enum:
{
Success: No description available. ,
Unauthorized: No description available. ,
NotFound: No description available. ,
}
,
Required: False ,
}
enum ,
deployment:
{
Description: Deployment information. ,
Required: False ,
}
{
deploymentId:
{
Description: Deployment identifier. ,
Required: False ,
}
string ,
deploymentState:
{
Description: Current status of the deployment. ,
Enum:
{
In_Progress: No description available. ,
Completed: No description available. ,
Queued: No description available. ,
Canceling: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentResult:
{
Description: The outcome of the deployment. ,
Enum:
{
Success: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentTime:
{
Description: The time when the deployment finished. ,
Format: date-time ,
Required: False ,
}
string ,
deploymentLogsUrl:
{
Description: Url to access repository action logs. ,
Required: False ,
}
string ,
}
,
message:
{
Description: Additional details about the deployment that can be shown to the user. ,
Required: False ,
}
string ,
}
,
pullRequest:
{
Description: Information regarding the pull request of the source control. ,
Required: False ,
}
{
url:
{
Description: URL of pull request ,
Required: False ,
}
string ,
state:
{
Description: State of the pull request ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
SourceControls_Get (updated)
Description :  Gets a source control byt its identifier.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SourceControls_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "contentTypes": {
              "Enum": {
                "new": [
                  [
                    "AnalyticsRule",
                    ""
                  ],
                  [
                    "AutomationRule",
                    ""
                  ],
                  [
                    "HuntingQuery",
                    ""
                  ],
                  [
                    "Parser",
                    ""
                  ],
                  [
                    "Playbook",
                    ""
                  ],
                  [
                    "Workbook",
                    ""
                  ]
                ],
                "old": [
                  [
                    "AnalyticRule",
                    ""
                  ],
                  [
                    "AutomationRule",
                    ""
                  ],
                  [
                    "HuntingQuery",
                    ""
                  ],
                  [
                    "Parser",
                    ""
                  ],
                  [
                    "Playbook",
                    ""
                  ],
                  [
                    "Workbook",
                    ""
                  ]
                ]
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/sourcecontrols/{sourceControlId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
sourceControlId:
{
Description: Source control Id ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: source control properties ,
Required: True ,
}
{
id:
{
Description: The id (a Guid) of the source control ,
Required: False ,
}
string ,
version:
{
Description: The version number associated with the source control ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the source control ,
Required: True ,
}
string ,
description:
{
Description: A description of the source control ,
Required: False ,
}
string ,
repoType:
{
Description: The repository type of the source control ,
Enum:
{
Github: No description available. ,
AzureDevOps: No description available. ,
}
,
Required: True ,
}
enum ,
contentTypes:
{
Description: Array of source control content types. ,
Required: True ,
}
[
string ,
]
,
repository:
{
Description: Repository metadata. ,
Required: True ,
}
{
url:
{
Description: Url of repository. ,
Required: True ,
}
string ,
branch:
{
Description: Branch name of repository. ,
Required: True ,
}
string ,
displayUrl:
{
Description: Display url of repository. ,
Required: False ,
}
string ,
deploymentLogsUrl:
{
Description: Url to access repository action logs. ,
Required: False ,
}
string ,
}
,
servicePrincipal:
{
Description: Service principal metadata. ,
Required: False ,
}
{
id:
{
Description: Id of service principal. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant id of service principal. ,
Required: False ,
}
string ,
appId:
{
Description: App id of service principal. ,
Required: False ,
}
string ,
credentialsExpireOn:
{
Description: Expiration time of service principal credentials. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
repositoryAccess:
{
Description: Repository access credentials. This is write-only object and it never returns back to a user. ,
Required: False ,
}
{
kind:
{
Description: The kind of repository access credentials ,
Enum:
{
OAuth: No description available. ,
PAT: No description available. ,
App: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: OAuth Code. Required when `kind` is `OAuth` ,
Required: False ,
}
string ,
state:
{
Description: OAuth State. Required when `kind` is `OAuth` ,
Required: False ,
}
string ,
clientId:
{
Description: OAuth ClientId. Required when `kind` is `OAuth` ,
Required: False ,
}
string ,
token:
{
Description: Personal Access Token. Required when `kind` is `PAT` ,
Required: False ,
}
string ,
installationId:
{
Description: Application installation ID. Required when `kind` is `App`. Supported by `GitHub` only. ,
Required: False ,
}
string ,
}
,
repositoryResourceInfo:
{
Description: Information regarding the resources created in user's repository. ,
Required: False ,
}
{
webhook:
{
Description: The webhook object created for the source-control. ,
Required: False ,
}
{
webhookId:
{
Description: Unique identifier for the webhook. ,
Required: False ,
}
string ,
webhookUrl:
{
Description: URL that gets invoked by the webhook. ,
Required: False ,
}
string ,
webhookSecretUpdateTime:
{
Description: Time when the webhook secret was updated. ,
Format: date-time ,
Required: False ,
}
string ,
rotateWebhookSecret:
{
Description: A flag to instruct the backend service to rotate webhook secret. ,
Required: False ,
}
boolean ,
}
,
gitHubResourceInfo:
{
Description: Resources created in GitHub for this source-control. ,
Required: False ,
}
{
appInstallationId:
{
Description: GitHub application installation id. ,
Required: False ,
}
string ,
}
,
azureDevOpsResourceInfo:
{
Description: Resources created in Azure DevOps for this source-control. ,
Required: False ,
}
{
pipelineId:
{
Description: Id of the pipeline created for the source-control. ,
Required: False ,
}
string ,
serviceConnectionId:
{
Description: Id of the service-connection created for the source-control. ,
Required: False ,
}
string ,
}
,
}
,
lastDeploymentInfo:
{
Description: Information regarding the latest deployment for the source control. ,
Required: False ,
}
{
deploymentFetchStatus:
{
Description: Status while fetching the last deployment. ,
Enum:
{
Success: No description available. ,
Unauthorized: No description available. ,
NotFound: No description available. ,
}
,
Required: False ,
}
enum ,
deployment:
{
Description: Deployment information. ,
Required: False ,
}
{
deploymentId:
{
Description: Deployment identifier. ,
Required: False ,
}
string ,
deploymentState:
{
Description: Current status of the deployment. ,
Enum:
{
In_Progress: No description available. ,
Completed: No description available. ,
Queued: No description available. ,
Canceling: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentResult:
{
Description: The outcome of the deployment. ,
Enum:
{
Success: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentTime:
{
Description: The time when the deployment finished. ,
Format: date-time ,
Required: False ,
}
string ,
deploymentLogsUrl:
{
Description: Url to access repository action logs. ,
Required: False ,
}
string ,
}
,
message:
{
Description: Additional details about the deployment that can be shown to the user. ,
Required: False ,
}
string ,
}
,
pullRequest:
{
Description: Information regarding the pull request of the source control. ,
Required: False ,
}
{
url:
{
Description: URL of pull request ,
Required: False ,
}
string ,
state:
{
Description: State of the pull request ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
SourceControls_Create (updated)
Description :  Creates a source control.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SourceControls_Create",
  "$parameters": {
    "sourceControl": {
      "$properties": {
        "properties": [
          {
            "contentTypes": {
              "Enum": {
                "new": [
                  [
                    "AnalyticsRule",
                    ""
                  ],
                  [
                    "AutomationRule",
                    ""
                  ],
                  [
                    "HuntingQuery",
                    ""
                  ],
                  [
                    "Parser",
                    ""
                  ],
                  [
                    "Playbook",
                    ""
                  ],
                  [
                    "Workbook",
                    ""
                  ]
                ],
                "old": [
                  [
                    "AnalyticRule",
                    ""
                  ],
                  [
                    "AutomationRule",
                    ""
                  ],
                  [
                    "HuntingQuery",
                    ""
                  ],
                  [
                    "Parser",
                    ""
                  ],
                  [
                    "Playbook",
                    ""
                  ],
                  [
                    "Workbook",
                    ""
                  ]
                ]
              }
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "contentTypes": {
              "Enum": {
                "new": [
                  [
                    "AnalyticsRule",
                    ""
                  ],
                  [
                    "AutomationRule",
                    ""
                  ],
                  [
                    "HuntingQuery",
                    ""
                  ],
                  [
                    "Parser",
                    ""
                  ],
                  [
                    "Playbook",
                    ""
                  ],
                  [
                    "Workbook",
                    ""
                  ]
                ],
                "old": [
                  [
                    "AnalyticRule",
                    ""
                  ],
                  [
                    "AutomationRule",
                    ""
                  ],
                  [
                    "HuntingQuery",
                    ""
                  ],
                  [
                    "Parser",
                    ""
                  ],
                  [
                    "Playbook",
                    ""
                  ],
                  [
                    "Workbook",
                    ""
                  ]
                ]
              }
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "contentTypes": {
              "Enum": {
                "new": [
                  [
                    "AnalyticsRule",
                    ""
                  ],
                  [
                    "AutomationRule",
                    ""
                  ],
                  [
                    "HuntingQuery",
                    ""
                  ],
                  [
                    "Parser",
                    ""
                  ],
                  [
                    "Playbook",
                    ""
                  ],
                  [
                    "Workbook",
                    ""
                  ]
                ],
                "old": [
                  [
                    "AnalyticRule",
                    ""
                  ],
                  [
                    "AutomationRule",
                    ""
                  ],
                  [
                    "HuntingQuery",
                    ""
                  ],
                  [
                    "Parser",
                    ""
                  ],
                  [
                    "Playbook",
                    ""
                  ],
                  [
                    "Workbook",
                    ""
                  ]
                ]
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/sourcecontrols/{sourceControlId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
sourceControlId:
{
Description: Source control Id ,
Required: True ,
}
string ,
sourceControl:
{
Description: The SourceControl ,
Required: True ,
}
{
properties:
{
Description: source control properties ,
Required: True ,
}
{
id:
{
Description: The id (a Guid) of the source control ,
Required: False ,
}
string ,
version:
{
Description: The version number associated with the source control ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the source control ,
Required: True ,
}
string ,
description:
{
Description: A description of the source control ,
Required: False ,
}
string ,
repoType:
{
Description: The repository type of the source control ,
Enum:
{
Github: No description available. ,
AzureDevOps: No description available. ,
}
,
Required: True ,
}
enum ,
contentTypes:
{
Description: Array of source control content types. ,
Required: True ,
}
[
string ,
]
,
repository:
{
Description: Repository metadata. ,
Required: True ,
}
{
url:
{
Description: Url of repository. ,
Required: True ,
}
string ,
branch:
{
Description: Branch name of repository. ,
Required: True ,
}
string ,
displayUrl:
{
Description: Display url of repository. ,
Required: False ,
}
string ,
deploymentLogsUrl:
{
Description: Url to access repository action logs. ,
Required: False ,
}
string ,
}
,
servicePrincipal:
{
Description: Service principal metadata. ,
Required: False ,
}
{
id:
{
Description: Id of service principal. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant id of service principal. ,
Required: False ,
}
string ,
appId:
{
Description: App id of service principal. ,
Required: False ,
}
string ,
credentialsExpireOn:
{
Description: Expiration time of service principal credentials. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
repositoryAccess:
{
Description: Repository access credentials. This is write-only object and it never returns back to a user. ,
Required: False ,
}
{
kind:
{
Description: The kind of repository access credentials ,
Enum:
{
OAuth: No description available. ,
PAT: No description available. ,
App: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: OAuth Code. Required when `kind` is `OAuth` ,
Required: False ,
}
string ,
state:
{
Description: OAuth State. Required when `kind` is `OAuth` ,
Required: False ,
}
string ,
clientId:
{
Description: OAuth ClientId. Required when `kind` is `OAuth` ,
Required: False ,
}
string ,
token:
{
Description: Personal Access Token. Required when `kind` is `PAT` ,
Required: False ,
}
string ,
installationId:
{
Description: Application installation ID. Required when `kind` is `App`. Supported by `GitHub` only. ,
Required: False ,
}
string ,
}
,
repositoryResourceInfo:
{
Description: Information regarding the resources created in user's repository. ,
Required: False ,
}
{
webhook:
{
Description: The webhook object created for the source-control. ,
Required: False ,
}
{
webhookId:
{
Description: Unique identifier for the webhook. ,
Required: False ,
}
string ,
webhookUrl:
{
Description: URL that gets invoked by the webhook. ,
Required: False ,
}
string ,
webhookSecretUpdateTime:
{
Description: Time when the webhook secret was updated. ,
Format: date-time ,
Required: False ,
}
string ,
rotateWebhookSecret:
{
Description: A flag to instruct the backend service to rotate webhook secret. ,
Required: False ,
}
boolean ,
}
,
gitHubResourceInfo:
{
Description: Resources created in GitHub for this source-control. ,
Required: False ,
}
{
appInstallationId:
{
Description: GitHub application installation id. ,
Required: False ,
}
string ,
}
,
azureDevOpsResourceInfo:
{
Description: Resources created in Azure DevOps for this source-control. ,
Required: False ,
}
{
pipelineId:
{
Description: Id of the pipeline created for the source-control. ,
Required: False ,
}
string ,
serviceConnectionId:
{
Description: Id of the service-connection created for the source-control. ,
Required: False ,
}
string ,
}
,
}
,
lastDeploymentInfo:
{
Description: Information regarding the latest deployment for the source control. ,
Required: False ,
}
{
deploymentFetchStatus:
{
Description: Status while fetching the last deployment. ,
Enum:
{
Success: No description available. ,
Unauthorized: No description available. ,
NotFound: No description available. ,
}
,
Required: False ,
}
enum ,
deployment:
{
Description: Deployment information. ,
Required: False ,
}
{
deploymentId:
{
Description: Deployment identifier. ,
Required: False ,
}
string ,
deploymentState:
{
Description: Current status of the deployment. ,
Enum:
{
In_Progress: No description available. ,
Completed: No description available. ,
Queued: No description available. ,
Canceling: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentResult:
{
Description: The outcome of the deployment. ,
Enum:
{
Success: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentTime:
{
Description: The time when the deployment finished. ,
Format: date-time ,
Required: False ,
}
string ,
deploymentLogsUrl:
{
Description: Url to access repository action logs. ,
Required: False ,
}
string ,
}
,
message:
{
Description: Additional details about the deployment that can be shown to the user. ,
Required: False ,
}
string ,
}
,
pullRequest:
{
Description: Information regarding the pull request of the source control. ,
Required: False ,
}
{
url:
{
Description: URL of pull request ,
Required: False ,
}
string ,
state:
{
Description: State of the pull request ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: source control properties ,
Required: True ,
}
{
id:
{
Description: The id (a Guid) of the source control ,
Required: False ,
}
string ,
version:
{
Description: The version number associated with the source control ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the source control ,
Required: True ,
}
string ,
description:
{
Description: A description of the source control ,
Required: False ,
}
string ,
repoType:
{
Description: The repository type of the source control ,
Enum:
{
Github: No description available. ,
AzureDevOps: No description available. ,
}
,
Required: True ,
}
enum ,
contentTypes:
{
Description: Array of source control content types. ,
Required: True ,
}
[
string ,
]
,
repository:
{
Description: Repository metadata. ,
Required: True ,
}
{
url:
{
Description: Url of repository. ,
Required: True ,
}
string ,
branch:
{
Description: Branch name of repository. ,
Required: True ,
}
string ,
displayUrl:
{
Description: Display url of repository. ,
Required: False ,
}
string ,
deploymentLogsUrl:
{
Description: Url to access repository action logs. ,
Required: False ,
}
string ,
}
,
servicePrincipal:
{
Description: Service principal metadata. ,
Required: False ,
}
{
id:
{
Description: Id of service principal. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant id of service principal. ,
Required: False ,
}
string ,
appId:
{
Description: App id of service principal. ,
Required: False ,
}
string ,
credentialsExpireOn:
{
Description: Expiration time of service principal credentials. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
repositoryAccess:
{
Description: Repository access credentials. This is write-only object and it never returns back to a user. ,
Required: False ,
}
{
kind:
{
Description: The kind of repository access credentials ,
Enum:
{
OAuth: No description available. ,
PAT: No description available. ,
App: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: OAuth Code. Required when `kind` is `OAuth` ,
Required: False ,
}
string ,
state:
{
Description: OAuth State. Required when `kind` is `OAuth` ,
Required: False ,
}
string ,
clientId:
{
Description: OAuth ClientId. Required when `kind` is `OAuth` ,
Required: False ,
}
string ,
token:
{
Description: Personal Access Token. Required when `kind` is `PAT` ,
Required: False ,
}
string ,
installationId:
{
Description: Application installation ID. Required when `kind` is `App`. Supported by `GitHub` only. ,
Required: False ,
}
string ,
}
,
repositoryResourceInfo:
{
Description: Information regarding the resources created in user's repository. ,
Required: False ,
}
{
webhook:
{
Description: The webhook object created for the source-control. ,
Required: False ,
}
{
webhookId:
{
Description: Unique identifier for the webhook. ,
Required: False ,
}
string ,
webhookUrl:
{
Description: URL that gets invoked by the webhook. ,
Required: False ,
}
string ,
webhookSecretUpdateTime:
{
Description: Time when the webhook secret was updated. ,
Format: date-time ,
Required: False ,
}
string ,
rotateWebhookSecret:
{
Description: A flag to instruct the backend service to rotate webhook secret. ,
Required: False ,
}
boolean ,
}
,
gitHubResourceInfo:
{
Description: Resources created in GitHub for this source-control. ,
Required: False ,
}
{
appInstallationId:
{
Description: GitHub application installation id. ,
Required: False ,
}
string ,
}
,
azureDevOpsResourceInfo:
{
Description: Resources created in Azure DevOps for this source-control. ,
Required: False ,
}
{
pipelineId:
{
Description: Id of the pipeline created for the source-control. ,
Required: False ,
}
string ,
serviceConnectionId:
{
Description: Id of the service-connection created for the source-control. ,
Required: False ,
}
string ,
}
,
}
,
lastDeploymentInfo:
{
Description: Information regarding the latest deployment for the source control. ,
Required: False ,
}
{
deploymentFetchStatus:
{
Description: Status while fetching the last deployment. ,
Enum:
{
Success: No description available. ,
Unauthorized: No description available. ,
NotFound: No description available. ,
}
,
Required: False ,
}
enum ,
deployment:
{
Description: Deployment information. ,
Required: False ,
}
{
deploymentId:
{
Description: Deployment identifier. ,
Required: False ,
}
string ,
deploymentState:
{
Description: Current status of the deployment. ,
Enum:
{
In_Progress: No description available. ,
Completed: No description available. ,
Queued: No description available. ,
Canceling: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentResult:
{
Description: The outcome of the deployment. ,
Enum:
{
Success: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentTime:
{
Description: The time when the deployment finished. ,
Format: date-time ,
Required: False ,
}
string ,
deploymentLogsUrl:
{
Description: Url to access repository action logs. ,
Required: False ,
}
string ,
}
,
message:
{
Description: Additional details about the deployment that can be shown to the user. ,
Required: False ,
}
string ,
}
,
pullRequest:
{
Description: Information regarding the pull request of the source control. ,
Required: False ,
}
{
url:
{
Description: URL of pull request ,
Required: False ,
}
string ,
state:
{
Description: State of the pull request ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: source control properties ,
Required: True ,
}
{
id:
{
Description: The id (a Guid) of the source control ,
Required: False ,
}
string ,
version:
{
Description: The version number associated with the source control ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the source control ,
Required: True ,
}
string ,
description:
{
Description: A description of the source control ,
Required: False ,
}
string ,
repoType:
{
Description: The repository type of the source control ,
Enum:
{
Github: No description available. ,
AzureDevOps: No description available. ,
}
,
Required: True ,
}
enum ,
contentTypes:
{
Description: Array of source control content types. ,
Required: True ,
}
[
string ,
]
,
repository:
{
Description: Repository metadata. ,
Required: True ,
}
{
url:
{
Description: Url of repository. ,
Required: True ,
}
string ,
branch:
{
Description: Branch name of repository. ,
Required: True ,
}
string ,
displayUrl:
{
Description: Display url of repository. ,
Required: False ,
}
string ,
deploymentLogsUrl:
{
Description: Url to access repository action logs. ,
Required: False ,
}
string ,
}
,
servicePrincipal:
{
Description: Service principal metadata. ,
Required: False ,
}
{
id:
{
Description: Id of service principal. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant id of service principal. ,
Required: False ,
}
string ,
appId:
{
Description: App id of service principal. ,
Required: False ,
}
string ,
credentialsExpireOn:
{
Description: Expiration time of service principal credentials. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
repositoryAccess:
{
Description: Repository access credentials. This is write-only object and it never returns back to a user. ,
Required: False ,
}
{
kind:
{
Description: The kind of repository access credentials ,
Enum:
{
OAuth: No description available. ,
PAT: No description available. ,
App: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: OAuth Code. Required when `kind` is `OAuth` ,
Required: False ,
}
string ,
state:
{
Description: OAuth State. Required when `kind` is `OAuth` ,
Required: False ,
}
string ,
clientId:
{
Description: OAuth ClientId. Required when `kind` is `OAuth` ,
Required: False ,
}
string ,
token:
{
Description: Personal Access Token. Required when `kind` is `PAT` ,
Required: False ,
}
string ,
installationId:
{
Description: Application installation ID. Required when `kind` is `App`. Supported by `GitHub` only. ,
Required: False ,
}
string ,
}
,
repositoryResourceInfo:
{
Description: Information regarding the resources created in user's repository. ,
Required: False ,
}
{
webhook:
{
Description: The webhook object created for the source-control. ,
Required: False ,
}
{
webhookId:
{
Description: Unique identifier for the webhook. ,
Required: False ,
}
string ,
webhookUrl:
{
Description: URL that gets invoked by the webhook. ,
Required: False ,
}
string ,
webhookSecretUpdateTime:
{
Description: Time when the webhook secret was updated. ,
Format: date-time ,
Required: False ,
}
string ,
rotateWebhookSecret:
{
Description: A flag to instruct the backend service to rotate webhook secret. ,
Required: False ,
}
boolean ,
}
,
gitHubResourceInfo:
{
Description: Resources created in GitHub for this source-control. ,
Required: False ,
}
{
appInstallationId:
{
Description: GitHub application installation id. ,
Required: False ,
}
string ,
}
,
azureDevOpsResourceInfo:
{
Description: Resources created in Azure DevOps for this source-control. ,
Required: False ,
}
{
pipelineId:
{
Description: Id of the pipeline created for the source-control. ,
Required: False ,
}
string ,
serviceConnectionId:
{
Description: Id of the service-connection created for the source-control. ,
Required: False ,
}
string ,
}
,
}
,
lastDeploymentInfo:
{
Description: Information regarding the latest deployment for the source control. ,
Required: False ,
}
{
deploymentFetchStatus:
{
Description: Status while fetching the last deployment. ,
Enum:
{
Success: No description available. ,
Unauthorized: No description available. ,
NotFound: No description available. ,
}
,
Required: False ,
}
enum ,
deployment:
{
Description: Deployment information. ,
Required: False ,
}
{
deploymentId:
{
Description: Deployment identifier. ,
Required: False ,
}
string ,
deploymentState:
{
Description: Current status of the deployment. ,
Enum:
{
In_Progress: No description available. ,
Completed: No description available. ,
Queued: No description available. ,
Canceling: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentResult:
{
Description: The outcome of the deployment. ,
Enum:
{
Success: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentTime:
{
Description: The time when the deployment finished. ,
Format: date-time ,
Required: False ,
}
string ,
deploymentLogsUrl:
{
Description: Url to access repository action logs. ,
Required: False ,
}
string ,
}
,
message:
{
Description: Additional details about the deployment that can be shown to the user. ,
Required: False ,
}
string ,
}
,
pullRequest:
{
Description: Information regarding the pull request of the source control. ,
Required: False ,
}
{
url:
{
Description: URL of pull request ,
Required: False ,
}
string ,
state:
{
Description: State of the pull request ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}