{ "swagger": "2.0", "info": { "title": "Microsoft.Security", "description": "REST APIs for Defender for DevOps", "version": "2025-03-01" }, "host": "management.azure.com", "schemes": [ "https" ], "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/listAvailableAzureDevOpsOrgs": { "post": { "tags": [ "DevOps" ], "summary": "Returns a list of all Azure DevOps organizations accessible by the user token consumed by the connector.", "operationId": "AzureDevOpsOrgs_ListAvailable", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Provides list of Azure DevOps organization details", "schema": { "$ref": "#/definitions/AzureDevOpsOrgListResponse" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ListAvailable_AzureDevOpsOrgs": { "$ref": "./examples/SecurityConnectorsDevOps/ListAvailableAzureDevOpsOrgs_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs": { "get": { "tags": [ "DevOps" ], "summary": "Returns a list of Azure DevOps organizations onboarded to the connector.", "operationId": "AzureDevOpsOrgs_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Provides a list of Azure DevOps organization details", "schema": { "$ref": "#/definitions/AzureDevOpsOrgListResponse" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List_AzureDevOpsOrgs": { "$ref": "./examples/SecurityConnectorsDevOps/ListAzureDevOpsOrgs_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}": { "get": { "tags": [ "DevOps" ], "summary": "Returns a monitored Azure DevOps organization resource.", "operationId": "AzureDevOpsOrgs_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "#/parameters/OrgName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Provides Azure DevOps organization details", "schema": { "$ref": "#/definitions/AzureDevOpsOrg" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get_AzureDevOpsOrgs": { "$ref": "./examples/SecurityConnectorsDevOps/GetAzureDevOpsOrgs_example.json" } } }, "put": { "tags": [ "DevOps" ], "summary": "Creates or updates monitored Azure DevOps organization details.", "operationId": "AzureDevOpsOrgs_CreateOrUpdate", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "#/parameters/OrgName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "azureDevOpsOrg", "description": "The Azure DevOps organization resource payload.", "required": true, "schema": { "$ref": "#/definitions/AzureDevOpsOrg" } } ], "responses": { "200": { "description": "Creates or updates monitored Azure DevOps organization details", "schema": { "$ref": "#/definitions/AzureDevOpsOrg" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/AzureDevOpsOrg" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-examples": { "CreateOrUpdate_AzureDevOpsOrgs": { "$ref": "./examples/SecurityConnectorsDevOps/CreateOrUpdateAzureDevOpsOrgs_example.json" } } }, "patch": { "tags": [ "DevOps" ], "summary": "Updates monitored Azure DevOps organization details.", "operationId": "AzureDevOpsOrgs_Update", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "#/parameters/OrgName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "azureDevOpsOrg", "description": "The Azure DevOps organization resource payload.", "required": true, "schema": { "$ref": "#/definitions/AzureDevOpsOrg" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AzureDevOpsOrg" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/AzureDevOpsOrg" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-examples": { "Update_AzureDevOpsOrgs": { "$ref": "./examples/SecurityConnectorsDevOps/UpdateAzureDevOpsOrgs_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects": { "get": { "tags": [ "DevOps" ], "summary": "Returns a list of Azure DevOps projects onboarded to the connector.", "operationId": "AzureDevOpsProjects_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "#/parameters/OrgName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Provides a list of Azure DevOps project details", "schema": { "$ref": "#/definitions/AzureDevOpsProjectListResponse" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List_AzureDevOpsProjects": { "$ref": "./examples/SecurityConnectorsDevOps/ListAzureDevOpsProjects_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}": { "get": { "tags": [ "DevOps" ], "summary": "Returns a monitored Azure DevOps project resource.", "operationId": "AzureDevOpsProjects_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "#/parameters/OrgName" }, { "$ref": "#/parameters/ProjectName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Provides Azure DevOps project details", "schema": { "$ref": "#/definitions/AzureDevOpsProject" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get_AzureDevOpsProjects": { "$ref": "./examples/SecurityConnectorsDevOps/GetAzureDevOpsProjects_example.json" } } }, "put": { "tags": [ "DevOps" ], "summary": "Creates or updates a monitored Azure DevOps project resource.", "operationId": "AzureDevOpsProjects_CreateOrUpdate", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "#/parameters/OrgName" }, { "$ref": "#/parameters/ProjectName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "azureDevOpsProject", "description": "The Azure DevOps project resource payload.", "required": true, "schema": { "$ref": "#/definitions/AzureDevOpsProject" } } ], "responses": { "200": { "description": "Creates or updates a monitored Azure DevOps project resource", "schema": { "$ref": "#/definitions/AzureDevOpsProject" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/AzureDevOpsProject" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-examples": { "CreateOrUpdate_AzureDevOpsProjects": { "$ref": "./examples/SecurityConnectorsDevOps/CreateOrUpdateAzureDevOpsProjects_example.json" } } }, "patch": { "tags": [ "DevOps" ], "summary": "Updates a monitored Azure DevOps project resource.", "operationId": "AzureDevOpsProjects_Update", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "#/parameters/OrgName" }, { "$ref": "#/parameters/ProjectName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "azureDevOpsProject", "description": "The Azure DevOps project resource payload.", "required": true, "schema": { "$ref": "#/definitions/AzureDevOpsProject" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AzureDevOpsProject" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/AzureDevOpsProject" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-examples": { "Update_AzureDevOpsProjects": { "$ref": "./examples/SecurityConnectorsDevOps/UpdateAzureDevOpsProjects_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}/repos": { "get": { "tags": [ "DevOps" ], "summary": "Returns a list of Azure DevOps repositories onboarded to the connector.", "operationId": "AzureDevOpsRepos_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "#/parameters/OrgName" }, { "$ref": "#/parameters/ProjectName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Provides a list of Azure DevOps repository details", "schema": { "$ref": "#/definitions/AzureDevOpsRepositoryListResponse" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List_AzureDevOpsRepos": { "$ref": "./examples/SecurityConnectorsDevOps/ListAzureDevOpsRepos_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}/repos/{repoName}": { "get": { "tags": [ "DevOps" ], "summary": "Returns a monitored Azure DevOps repository resource.", "operationId": "AzureDevOpsRepos_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "#/parameters/OrgName" }, { "$ref": "#/parameters/ProjectName" }, { "$ref": "#/parameters/RepoName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Provides Azure DevOps repository details", "schema": { "$ref": "#/definitions/AzureDevOpsRepository" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get_AzureDevOpsRepos": { "$ref": "./examples/SecurityConnectorsDevOps/GetAzureDevOpsRepos_example.json" } } }, "put": { "tags": [ "DevOps" ], "summary": "Creates or updates a monitored Azure DevOps repository resource.", "operationId": "AzureDevOpsRepos_CreateOrUpdate", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "#/parameters/OrgName" }, { "$ref": "#/parameters/ProjectName" }, { "$ref": "#/parameters/RepoName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "azureDevOpsRepository", "description": "The Azure DevOps repository resource payload.", "required": true, "schema": { "$ref": "#/definitions/AzureDevOpsRepository" } } ], "responses": { "200": { "description": "Creates or updates a monitored Azure DevOps repository resource", "schema": { "$ref": "#/definitions/AzureDevOpsRepository" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/AzureDevOpsRepository" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-examples": { "CreateOrUpdate_AzureDevOpsRepos": { "$ref": "./examples/SecurityConnectorsDevOps/CreateOrUpdateAzureDevOpsRepos_example.json" } } }, "patch": { "tags": [ "DevOps" ], "summary": "Updates a monitored Azure DevOps repository resource.", "operationId": "AzureDevOpsRepos_Update", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "#/parameters/OrgName" }, { "$ref": "#/parameters/ProjectName" }, { "$ref": "#/parameters/RepoName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "azureDevOpsRepository", "description": "The Azure DevOps repository resource payload.", "required": true, "schema": { "$ref": "#/definitions/AzureDevOpsRepository" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AzureDevOpsRepository" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/AzureDevOpsRepository" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-examples": { "Update_AzureDevOpsRepos": { "$ref": "./examples/SecurityConnectorsDevOps/UpdateAzureDevOpsRepos_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops": { "get": { "tags": [ "DevOps" ], "summary": "List DevOps Configurations.", "operationId": "DevOpsConfigurations_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DevOpsConfigurationListResponse" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List_DevOpsConfigurations": { "$ref": "./examples/SecurityConnectorsDevOps/ListDevOpsConfigurations_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default": { "get": { "tags": [ "DevOps" ], "summary": "Gets a DevOps Configuration.", "operationId": "DevOpsConfigurations_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DevOpsConfiguration" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get_DevOpsConfigurations": { "$ref": "./examples/SecurityConnectorsDevOps/GetDevOpsConfigurations_example.json" }, "Get_DevOpsConfigurations_WithCapabilities": { "$ref": "./examples/SecurityConnectorsDevOps/GetDevOpsConfigurationsWithCapabilities_example.json" }, "Get_DevOpsConfigurations_WithAgentlessConfigurations": { "$ref": "./examples/SecurityConnectorsDevOps/GetDevOpsConfigurationsWithAgentlessConfigurations_example.json" } } }, "put": { "tags": [ "DevOps" ], "summary": "Creates or updates a DevOps Configuration.", "operationId": "DevOpsConfigurations_CreateOrUpdate", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "devOpsConfiguration", "description": "The DevOps configuration resource payload.", "required": true, "schema": { "$ref": "#/definitions/DevOpsConfiguration" } } ], "responses": { "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DevOpsConfiguration" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/DevOpsConfiguration" } }, "200": { "description": "Creates or updates a DevOps Configuration", "schema": { "$ref": "#/definitions/DevOpsConfiguration" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-examples": { "CreateOrUpdate_DevOpsConfigurations_OnboardCurrentAndFuture": { "$ref": "./examples/SecurityConnectorsDevOps/CreateOrUpdateDevOpsConfigurationsOnboardCurrentAndFuture_example.json" }, "CreateOrUpdate_DevOpsConfigurations_OnboardCurrentOnly": { "$ref": "./examples/SecurityConnectorsDevOps/CreateOrUpdateDevOpsConfigurationsOnboardCurrentOnly_example.json" }, "CreateOrUpdate_DevOpsConfigurations_OnboardSelected": { "$ref": "./examples/SecurityConnectorsDevOps/CreateOrUpdateDevOpsConfigurationsOnboardSelected_example.json" }, "CreateOrUpdate_DevOpsConfigurations_WithAgentlessConfigurations": { "$ref": "./examples/SecurityConnectorsDevOps/CreateOrUpdateDevOpsConfigurationsWithAgentlessConfigurations_example.json" } } }, "patch": { "tags": [ "DevOps" ], "summary": "Updates a DevOps Configuration.", "operationId": "DevOpsConfigurations_Update", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "devOpsConfiguration", "description": "The DevOps configuration resource payload.", "required": true, "schema": { "$ref": "#/definitions/DevOpsConfiguration" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DevOpsConfiguration" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DevOpsConfiguration" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-examples": { "Update_DevOpsConfigurations": { "$ref": "./examples/SecurityConnectorsDevOps/UpdateDevOpsConfigurations_example.json" } } }, "delete": { "tags": [ "DevOps" ], "summary": "Deletes a DevOps Connector.", "operationId": "DevOpsConfigurations_Delete", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { "description": "Accepted" }, "204": { "description": "NoContent" }, "200": { "description": "OK" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Delete_DevOpsConfigurations": { "$ref": "./examples/SecurityConnectorsDevOps/DeleteDevOpsConfigurations_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/listAvailableGitHubOwners": { "post": { "tags": [ "DevOps" ], "summary": "Returns a list of all GitHub owners accessible by the user token consumed by the connector.", "operationId": "GitHubOwners_ListAvailable", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Provides list of GitHub owner resources", "schema": { "$ref": "#/definitions/GitHubOwnerListResponse" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ListAvailable_GitHubOwners": { "$ref": "./examples/SecurityConnectorsDevOps/ListAvailableGitHubOwners_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitHubOwners": { "get": { "tags": [ "DevOps" ], "summary": "Returns a list of GitHub owners onboarded to the connector.", "operationId": "GitHubOwners_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Provides list of GitHub owner resources", "schema": { "$ref": "#/definitions/GitHubOwnerListResponse" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List_GitHubOwners": { "$ref": "./examples/SecurityConnectorsDevOps/ListGitHubOwners_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitHubOwners/{ownerName}": { "get": { "tags": [ "DevOps" ], "summary": "Returns a monitored GitHub owner.", "operationId": "GitHubOwners_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "#/parameters/OwnerName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Provides GitHub owner details", "schema": { "$ref": "#/definitions/GitHubOwner" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get_GitHubOwners": { "$ref": "./examples/SecurityConnectorsDevOps/GetGitHubOwners_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitHubOwners/{ownerName}/repos": { "get": { "tags": [ "DevOps" ], "summary": "Returns a list of GitHub repositories onboarded to the connector.", "operationId": "GitHubRepos_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "#/parameters/OwnerName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Provides list of GitHub repository resources", "schema": { "$ref": "#/definitions/GitHubRepositoryListResponse" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List_GitHubRepos": { "$ref": "./examples/SecurityConnectorsDevOps/ListGitHubRepos_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitHubOwners/{ownerName}/repos/{repoName}": { "get": { "tags": [ "DevOps" ], "summary": "Returns a monitored GitHub repository.", "operationId": "GitHubRepos_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "#/parameters/OwnerName" }, { "$ref": "#/parameters/RepoName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Provides GitHub repository details", "schema": { "$ref": "#/definitions/GitHubRepository" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get_GitHubRepos": { "$ref": "./examples/SecurityConnectorsDevOps/GetGitHubRepos_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/listAvailableGitLabGroups": { "post": { "tags": [ "DevOps" ], "summary": "Returns a list of all GitLab groups accessible by the user token consumed by the connector.", "operationId": "GitLabGroups_ListAvailable", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Provides a list of GitLab Group details", "schema": { "$ref": "#/definitions/GitLabGroupListResponse" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ListAvailable_GitLabGroups": { "$ref": "./examples/SecurityConnectorsDevOps/ListAvailableGitLabGroups_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitLabGroups": { "get": { "tags": [ "DevOps" ], "summary": "Returns a list of GitLab groups onboarded to the connector.", "operationId": "GitLabGroups_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Provides a list of GitLab Group details", "schema": { "$ref": "#/definitions/GitLabGroupListResponse" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List_GitLabGroups": { "$ref": "./examples/SecurityConnectorsDevOps/ListGitLabGroups_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitLabGroups/{groupFQName}": { "get": { "tags": [ "DevOps" ], "summary": "Returns a monitored GitLab Group resource for a given fully-qualified name.", "operationId": "GitLabGroups_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "#/parameters/GroupFQName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Provides GitLab Group details", "schema": { "$ref": "#/definitions/GitLabGroup" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get_GitLabGroups": { "$ref": "./examples/SecurityConnectorsDevOps/GetGitLabGroups_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitLabGroups/{groupFQName}/listSubgroups": { "post": { "tags": [ "DevOps" ], "summary": "Gets nested subgroups of given GitLab Group which are onboarded to the connector.", "operationId": "GitLabSubgroups_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "#/parameters/GroupFQName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Provides a list of GitLab Group details for subgroups", "schema": { "$ref": "#/definitions/GitLabGroupListResponse" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List_GitLabSubgroups": { "$ref": "./examples/SecurityConnectorsDevOps/ListGitLabSubgroups_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitLabGroups/{groupFQName}/projects": { "get": { "tags": [ "DevOps" ], "summary": "Gets a list of GitLab projects that are directly owned by given group and onboarded to the connector.", "operationId": "GitLabProjects_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "#/parameters/GroupFQName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Provides a list of GitLab Project details", "schema": { "$ref": "#/definitions/GitLabProjectListResponse" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List_GitLabProjects": { "$ref": "./examples/SecurityConnectorsDevOps/ListGitLabProjects_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitLabGroups/{groupFQName}/projects/{projectName}": { "get": { "tags": [ "DevOps" ], "summary": "Returns a monitored GitLab Project resource for a given fully-qualified group name and project name.", "operationId": "GitLabProjects_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "#/parameters/GroupFQName" }, { "$ref": "#/parameters/ProjectName" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Provides GitLab Project details", "schema": { "$ref": "#/definitions/GitLabProject" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get_GitLabProjects": { "$ref": "./examples/SecurityConnectorsDevOps/GetGitLabProjects_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/operationResults/{operationResultId}": { "get": { "tags": [ "DevOps" ], "summary": "Get devops long running operation result.", "operationId": "DevOpsOperationResults_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/SecurityConnectorName" }, { "$ref": "#/parameters/OperationResultId" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/OperationStatusResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get_DevOpsOperationResults_Succeeded": { "$ref": "./examples/SecurityConnectorsDevOps/GetDevOpsOperationResultsSucceeded_example.json" }, "Get_DevOpsOperationResults_Failed": { "$ref": "./examples/SecurityConnectorsDevOps/GetDevOpsOperationResultsFailed_example.json" } } } } }, "definitions": { "ActionableRemediation": { "description": "Configuration payload for PR Annotations.", "type": "object", "properties": { "state": { "$ref": "#/definitions/ActionableRemediationState" }, "categoryConfigurations": { "description": "Gets or sets list of categories and severity levels.", "type": "array", "items": { "$ref": "#/definitions/CategoryConfiguration" }, "x-ms-identifiers": [] }, "branchConfiguration": { "$ref": "#/definitions/TargetBranchConfiguration" }, "inheritFromParentState": { "$ref": "#/definitions/InheritFromParentState" } } }, "ActionableRemediationState": { "description": "ActionableRemediation Setting.\r\nNone - the setting was never set.\r\nEnabled - ActionableRemediation is enabled.\r\nDisabled - ActionableRemediation is disabled.", "enum": [ "None", "Disabled", "Enabled" ], "type": "string", "x-ms-enum": { "name": "ActionableRemediationState", "modelAsString": true, "modelAsExtensible": true } }, "AgentlessConfiguration": { "description": "Details about Agentless configuration.", "type": "object", "properties": { "agentlessEnabled": { "$ref": "#/definitions/AgentlessEnablement" }, "agentlessAutoDiscovery": { "$ref": "#/definitions/AutoDiscovery" }, "scanners": { "description": "Gets or sets the scanners for the connector.", "type": "array", "items": { "type": "string" } }, "inventoryListType": { "$ref": "#/definitions/InventoryListKind" }, "inventoryList": { "description": "Gets or sets the inventory list for inclusion or exclusion from Agentless.\r\nWill be ignored if agentless auto-discovery is enabled.", "type": "array", "items": { "$ref": "#/definitions/InventoryList" } } } }, "AgentlessEnablement": { "description": "Agentless Enablement states.", "enum": [ "Disabled", "Enabled", "NotApplicable" ], "type": "string", "x-ms-enum": { "name": "AgentlessEnablement", "modelAsString": true, "modelAsExtensible": true } }, "AnnotateDefaultBranchState": { "description": "Configuration of PR Annotations on default branch.\r\n\r\nEnabled - PR Annotations are enabled on the resource's default branch.\r\nDisabled - PR Annotations are disabled on the resource's default branch.", "enum": [ "Disabled", "Enabled" ], "type": "string", "x-ms-enum": { "name": "AnnotateDefaultBranchState", "modelAsString": true, "modelAsExtensible": true } }, "Authorization": { "description": "Authorization payload.", "type": "object", "properties": { "code": { "description": "Gets or sets one-time OAuth code to exchange for refresh and access tokens.\r\n\r\nOnly used during PUT/PATCH operations. The secret is cleared during GET.", "type": "string", "example": "00000000000000000000.", "x-ms-secret": true } } }, "AutoDiscovery": { "description": "AutoDiscovery states.", "enum": [ "Disabled", "Enabled", "NotApplicable" ], "type": "string", "x-ms-enum": { "name": "AutoDiscovery", "modelAsString": true, "modelAsExtensible": true } }, "AzureDevOpsOrg": { "description": "Azure DevOps Organization resource.", "type": "object", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "properties": { "systemData": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" }, "properties": { "$ref": "#/definitions/AzureDevOpsOrgProperties" } } }, "AzureDevOpsOrgListResponse": { "description": "List of RP resources which supports pagination.", "type": "object", "properties": { "value": { "description": "Gets or sets list of resources.", "type": "array", "items": { "$ref": "#/definitions/AzureDevOpsOrg" }, "x-ms-identifiers": [] }, "nextLink": { "description": "Gets or sets next link to scroll over the results.", "type": "string" } } }, "AzureDevOpsOrgProperties": { "description": "Azure DevOps Organization properties.", "type": "object", "properties": { "provisioningStatusMessage": { "description": "Gets the resource status message.", "type": "string", "example": "Resource onboarded successful.", "readOnly": true }, "provisioningStatusUpdateTimeUtc": { "format": "date-time", "description": "Gets the time when resource was last checked.", "type": "string", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/DevOpsProvisioningState" }, "onboardingState": { "$ref": "#/definitions/OnboardingState" }, "actionableRemediation": { "$ref": "#/definitions/ActionableRemediation" } } }, "AzureDevOpsOrganizationConfiguration": { "description": "AzureDevOps Org Inventory Configuration.", "type": "object", "properties": { "autoDiscovery": { "$ref": "#/definitions/AutoDiscovery" }, "projectConfigs": { "description": "AzureDevOps Project Inventory Configuration.\r\nDictionary of AzureDevOps project name to desired project configuration.\r\nIf AutoDiscovery is Enabled, this field should be empty or null.", "type": "object", "additionalProperties": { "$ref": "#/definitions/AzureDevOpsProjectConfiguration" }, "x-nullable": true } } }, "AzureDevOpsProject": { "description": "Azure DevOps Project resource.", "type": "object", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "properties": { "systemData": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" }, "properties": { "$ref": "#/definitions/AzureDevOpsProjectProperties" } } }, "AzureDevOpsProjectConfiguration": { "description": "AzureDevOps Project Inventory Configuration.", "type": "object", "properties": { "autoDiscovery": { "$ref": "#/definitions/AutoDiscovery" }, "repositoryConfigs": { "description": "AzureDevOps Repository Inventory Configuration.\r\nDictionary of AzureDevOps repository name to desired repository configuration.\r\nIf AutoDiscovery is Enabled, this field should be null or empty.", "type": "object", "additionalProperties": { "$ref": "#/definitions/BaseResourceConfiguration" }, "x-nullable": true } } }, "AzureDevOpsProjectListResponse": { "description": "List of RP resources which supports pagination.", "type": "object", "properties": { "value": { "description": "Gets or sets list of resources.", "type": "array", "items": { "$ref": "#/definitions/AzureDevOpsProject" }, "x-ms-identifiers": [] }, "nextLink": { "description": "Gets or sets next link to scroll over the results.", "type": "string" } } }, "AzureDevOpsProjectProperties": { "description": "Azure DevOps Project properties.", "type": "object", "properties": { "provisioningStatusMessage": { "description": "Gets the resource status message.", "type": "string", "example": "Resource onboarded successful.", "readOnly": true }, "provisioningStatusUpdateTimeUtc": { "format": "date-time", "description": "Gets the time when resource was last checked.", "type": "string", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/DevOpsProvisioningState" }, "parentOrgName": { "description": "Gets or sets parent Azure DevOps Organization name.", "type": "string" }, "projectId": { "description": "Gets or sets Azure DevOps Project id.", "type": "string", "readOnly": true }, "onboardingState": { "$ref": "#/definitions/OnboardingState" }, "actionableRemediation": { "$ref": "#/definitions/ActionableRemediation" } } }, "AzureDevOpsRepository": { "description": "Azure DevOps Repository resource.", "type": "object", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "properties": { "systemData": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" }, "properties": { "$ref": "#/definitions/AzureDevOpsRepositoryProperties" } } }, "AzureDevOpsRepositoryListResponse": { "description": "List of RP resources which supports pagination.", "type": "object", "properties": { "value": { "description": "Gets or sets list of resources.", "type": "array", "items": { "$ref": "#/definitions/AzureDevOpsRepository" }, "x-ms-identifiers": [] }, "nextLink": { "description": "Gets or sets next link to scroll over the results.", "type": "string" } } }, "AzureDevOpsRepositoryProperties": { "description": "Azure DevOps Repository properties.", "type": "object", "properties": { "provisioningStatusMessage": { "description": "Gets the resource status message.", "type": "string", "example": "Resource onboarded successful.", "readOnly": true }, "provisioningStatusUpdateTimeUtc": { "format": "date-time", "description": "Gets the time when resource was last checked.", "type": "string", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/DevOpsProvisioningState" }, "parentOrgName": { "description": "Gets or sets parent Azure DevOps Organization name.", "type": "string" }, "parentProjectName": { "description": "Gets or sets parent Azure DevOps Project name.", "type": "string" }, "repoId": { "description": "Gets or sets Azure DevOps Repository id.", "type": "string", "readOnly": true }, "repoUrl": { "description": "Gets or sets Azure DevOps Repository url.", "type": "string", "readOnly": true }, "visibility": { "description": "Gets or sets Azure DevOps repository visibility, whether it is public or private etc.", "type": "string", "readOnly": true }, "onboardingState": { "$ref": "#/definitions/OnboardingState" }, "actionableRemediation": { "$ref": "#/definitions/ActionableRemediation" } } }, "BaseResourceConfiguration": { "description": "Base Resource Inventory configuration changes.", "type": "object", "properties": { "desiredOnboardingState": { "$ref": "#/definitions/DesiredOnboardingState" } } }, "CategoryConfiguration": { "description": "Severity level per category configuration for PR Annotations.", "type": "object", "properties": { "minimumSeverityLevel": { "description": "Gets or sets minimum severity level for a given category.", "type": "string" }, "category": { "$ref": "#/definitions/RuleCategory" } } }, "DesiredOnboardingState": { "description": "Onboarding states.", "enum": [ "Disabled", "Enabled" ], "type": "string", "x-ms-enum": { "name": "DesiredOnboardingState", "modelAsString": true, "modelAsExtensible": true } }, "DevOpsCapability": { "description": "Details about DevOps capability.", "type": "object", "properties": { "name": { "description": "Gets the name of the DevOps capability.", "type": "string", "readOnly": true }, "value": { "description": "Gets the value of the DevOps capability.", "type": "string", "readOnly": true } } }, "DevOpsConfiguration": { "description": "DevOps Configuration resource.", "type": "object", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "properties": { "systemData": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" }, "properties": { "$ref": "#/definitions/DevOpsConfigurationProperties" } } }, "DevOpsConfigurationListResponse": { "description": "List of RP resources which supports pagination.", "type": "object", "properties": { "value": { "description": "Gets or sets list of resources.", "type": "array", "items": { "$ref": "#/definitions/DevOpsConfiguration" }, "x-ms-identifiers": [] }, "nextLink": { "description": "Gets or sets next link to scroll over the results.", "type": "string" } } }, "DevOpsConfigurationProperties": { "description": "DevOps Configuration properties.", "type": "object", "properties": { "provisioningStatusMessage": { "description": "Gets the resource status message.", "type": "string", "example": "Resource onboarded successful.", "readOnly": true }, "provisioningStatusUpdateTimeUtc": { "format": "date-time", "description": "Gets the time when resource was last checked.", "type": "string", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/DevOpsProvisioningState" }, "authorization": { "$ref": "#/definitions/Authorization" }, "autoDiscovery": { "$ref": "#/definitions/AutoDiscovery" }, "topLevelInventoryList": { "description": "List of top-level inventory to select when AutoDiscovery is disabled.\r\nThis field is ignored when AutoDiscovery is enabled.", "type": "array", "items": { "type": "string" } }, "capabilities": { "description": "List of capabilities assigned to the DevOps configuration during the discovery process.", "type": "array", "items": { "$ref": "#/definitions/DevOpsCapability" }, "x-ms-identifiers": [], "readOnly": true }, "agentlessConfiguration": { "$ref": "#/definitions/AgentlessConfiguration" } } }, "DevOpsProvisioningState": { "description": "The provisioning state of the resource.\r\n\r\nPending - Provisioning pending.\r\nFailed - Provisioning failed.\r\nSucceeded - Successful provisioning.\r\nCanceled - Provisioning canceled.\r\nPendingDeletion - Deletion pending.\r\nDeletionSuccess - Deletion successful.\r\nDeletionFailure - Deletion failure.", "enum": [ "Succeeded", "Failed", "Canceled", "Pending", "PendingDeletion", "DeletionSuccess", "DeletionFailure" ], "type": "string", "x-ms-enum": { "name": "DevOpsProvisioningState", "modelAsString": true, "modelAsExtensible": true }, "readOnly": true }, "GitHubOwner": { "description": "GitHub Owner resource.", "type": "object", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "properties": { "systemData": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" }, "properties": { "$ref": "#/definitions/GitHubOwnerProperties" } } }, "GitHubOwnerConfiguration": { "description": "GitHub Owner Inventory Configuration.", "type": "object", "properties": { "autoDiscovery": { "$ref": "#/definitions/AutoDiscovery" }, "repositoryConfigs": { "description": "GitHub Repository Inventory Configuration.\r\nDictionary of GitHub repository name to desired repository configuration.\r\nIf AutoDiscovery is Enabled, this field should be null or empty.", "type": "object", "additionalProperties": { "$ref": "#/definitions/BaseResourceConfiguration" }, "x-nullable": true } } }, "GitHubOwnerListResponse": { "description": "List of RP resources which supports pagination.", "type": "object", "properties": { "value": { "description": "Gets or sets list of resources.", "type": "array", "items": { "$ref": "#/definitions/GitHubOwner" }, "x-ms-identifiers": [] }, "nextLink": { "description": "Gets or sets next link to scroll over the results.", "type": "string" } } }, "GitHubOwnerProperties": { "description": "GitHub Owner properties.", "type": "object", "properties": { "provisioningStatusMessage": { "description": "Gets the resource status message.", "type": "string", "example": "Resource onboarded successful.", "readOnly": true }, "provisioningStatusUpdateTimeUtc": { "format": "date-time", "description": "Gets the time when resource was last checked.", "type": "string", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/DevOpsProvisioningState" }, "ownerUrl": { "description": "Gets or sets GitHub Owner url.", "type": "string", "readOnly": true }, "gitHubInternalId": { "description": "Gets or sets internal GitHub id.", "type": "string", "readOnly": true }, "onboardingState": { "$ref": "#/definitions/OnboardingState" } } }, "GitHubRepository": { "description": "GitHub Repository resource.", "type": "object", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "properties": { "systemData": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" }, "properties": { "$ref": "#/definitions/GitHubRepositoryProperties" } } }, "GitHubRepositoryListResponse": { "description": "List of RP resources which supports pagination.", "type": "object", "properties": { "value": { "description": "Gets or sets list of resources.", "type": "array", "items": { "$ref": "#/definitions/GitHubRepository" }, "x-ms-identifiers": [] }, "nextLink": { "description": "Gets or sets next link to scroll over the results.", "type": "string" } } }, "GitHubRepositoryProperties": { "description": "GitHub Repository properties.", "type": "object", "properties": { "provisioningStatusMessage": { "description": "Gets the resource status message.", "type": "string", "example": "Resource onboarded successful.", "readOnly": true }, "provisioningStatusUpdateTimeUtc": { "format": "date-time", "description": "Gets the time when resource was last checked.", "type": "string", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/DevOpsProvisioningState" }, "repoId": { "description": "Gets or sets GitHub Repository id.\r\n\r\nThis is a numeric id defined by Github.\r\nEg: \"123456\".", "type": "string", "readOnly": true }, "repoName": { "description": "Gets or sets GitHub Repository name.\r\nEg: \"new-repo-1\".", "type": "string", "readOnly": true }, "repoFullName": { "description": "Gets or sets GitHub Full Name.\r\nRepository name, prefixed with Owner name.\r\nEg: \"my-org/new-repo-1\".", "type": "string", "readOnly": true }, "onboardingState": { "$ref": "#/definitions/OnboardingState" }, "repoUrl": { "description": "Gets or sets GitHub Repository url.", "type": "string", "readOnly": true }, "parentOwnerName": { "description": "Gets or sets parent GitHub Owner name.", "type": "string" } } }, "GitLabGroup": { "description": "GitLab Group resource.", "type": "object", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "properties": { "systemData": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" }, "properties": { "$ref": "#/definitions/GitLabGroupProperties" } } }, "GitLabGroupConfiguration": { "description": "GitLab Group Inventory Configuration.", "type": "object", "properties": { "autoDiscovery": { "$ref": "#/definitions/AutoDiscovery" }, "projectConfigs": { "description": "GitLab Project Inventory Configuration.\r\nDictionary of GitLab fully-qualified project name to desired project configuration.\r\nIf AutoDiscovery is Enabled, this field should be null or empty.", "type": "object", "additionalProperties": { "$ref": "#/definitions/BaseResourceConfiguration" }, "x-nullable": true } } }, "GitLabGroupListResponse": { "description": "List of RP resources which supports pagination.", "type": "object", "properties": { "value": { "description": "Gets or sets list of resources.", "type": "array", "items": { "$ref": "#/definitions/GitLabGroup" }, "x-ms-identifiers": [] }, "nextLink": { "description": "Gets or sets next link to scroll over the results.", "type": "string" } } }, "GitLabGroupProperties": { "description": "GitLab Group properties.", "type": "object", "properties": { "provisioningStatusMessage": { "description": "Gets the resource status message.", "type": "string", "example": "Resource onboarded successful.", "readOnly": true }, "provisioningStatusUpdateTimeUtc": { "format": "date-time", "description": "Gets the time when resource was last checked.", "type": "string", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/DevOpsProvisioningState" }, "fullyQualifiedName": { "description": "Gets or sets the fully-qualified name of the Group object.\r\n\r\nThis contains the entire namespace hierarchy where namespaces are separated by the '$' character.", "type": "string", "readOnly": true }, "fullyQualifiedFriendlyName": { "description": "Gets or sets the human readable fully-qualified name of the Group object.\r\n\r\nThis contains the entire namespace hierarchy as seen on GitLab UI where namespaces are separated by the '/' character.", "type": "string", "readOnly": true }, "url": { "description": "Gets or sets the url of the GitLab Group.", "type": "string", "readOnly": true }, "onboardingState": { "$ref": "#/definitions/OnboardingState" } } }, "GitLabProject": { "description": "GitLab Project resource.", "type": "object", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "properties": { "systemData": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" }, "properties": { "$ref": "#/definitions/GitLabProjectProperties" } } }, "GitLabProjectListResponse": { "description": "List of RP resources which supports pagination.", "type": "object", "properties": { "value": { "description": "Gets or sets list of resources.", "type": "array", "items": { "$ref": "#/definitions/GitLabProject" }, "x-ms-identifiers": [] }, "nextLink": { "description": "Gets or sets next link to scroll over the results.", "type": "string" } } }, "GitLabProjectProperties": { "description": "GitLab Project properties.", "type": "object", "properties": { "provisioningStatusMessage": { "description": "Gets the resource status message.", "type": "string", "example": "Resource onboarded successful.", "readOnly": true }, "provisioningStatusUpdateTimeUtc": { "format": "date-time", "description": "Gets the time when resource was last checked.", "type": "string", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/DevOpsProvisioningState" }, "fullyQualifiedName": { "description": "Gets or sets the fully-qualified name of the project object.\r\n\r\nThis contains the entire hierarchy where entities are separated by the '$' character.", "type": "string", "readOnly": true }, "fullyQualifiedFriendlyName": { "description": "Gets or sets the human readable fully-qualified name of the Project object.\r\n\r\nThis contains the entire namespace hierarchy as seen on GitLab UI where entities are separated by the '/' character.", "type": "string", "readOnly": true }, "fullyQualifiedParentGroupName": { "description": "Gets or sets the fully-qualified name of the project's parent group object.\r\n\r\nThis contains the entire hierarchy where namespaces are separated by the '$' character.", "type": "string", "readOnly": true }, "url": { "description": "Gets or sets the url of the GitLab Project.", "type": "string", "readOnly": true }, "onboardingState": { "$ref": "#/definitions/OnboardingState" } } }, "InheritFromParentState": { "description": "Update Settings.\r\n\r\nEnabled - Resource should inherit configurations from parent.\r\nDisabled - Resource should not inherit configurations from parent.", "enum": [ "Disabled", "Enabled" ], "type": "string", "x-ms-enum": { "name": "InheritFromParentState", "modelAsString": true, "modelAsExtensible": true } }, "InventoryKind": { "description": "Types for inventory kind.", "enum": [ "AzureDevOpsOrganization", "AzureDevOpsProject", "AzureDevOpsRepository", "GitHubOwner", "GitHubRepository" ], "type": "string", "x-ms-enum": { "name": "InventoryKind", "modelAsString": true, "modelAsExtensible": true } }, "InventoryList": { "description": "Model for inventory to be included or excluded from Agentless.", "type": "object", "properties": { "inventoryKind": { "$ref": "#/definitions/InventoryKind" }, "value": { "description": "Gets or sets the value for inventory type.", "type": "string" } } }, "InventoryListKind": { "description": "Types for inventory list.", "enum": [ "Inclusion", "Exclusion" ], "type": "string", "x-ms-enum": { "name": "InventoryListKind", "modelAsString": true, "modelAsExtensible": true } }, "OnboardingState": { "description": "Details about resource onboarding status across all connectors.\r\n\r\nOnboardedByOtherConnector - this resource has already been onboarded to another connector. This is only applicable to top-level resources.\r\nOnboarded - this resource has already been onboarded by the specified connector.\r\nNotOnboarded - this resource has not been onboarded to any connector.\r\nNotApplicable - the onboarding state is not applicable to the current endpoint.", "enum": [ "NotApplicable", "OnboardedByOtherConnector", "Onboarded", "NotOnboarded" ], "type": "string", "x-ms-enum": { "name": "OnboardingState", "modelAsString": true, "modelAsExtensible": true } }, "RuleCategory": { "description": "Rule categories.\r\nCode - code scanning results.\r\nArtifact scanning results.\r\nDependencies scanning results.\r\nIaC results.\r\nSecrets scanning results.\r\nContainer scanning results.", "enum": [ "Code", "Artifacts", "Dependencies", "Secrets", "IaC", "Containers" ], "type": "string", "x-ms-enum": { "name": "RuleCategory", "modelAsString": true, "modelAsExtensible": true } }, "TargetBranchConfiguration": { "description": "Repository branch configuration for PR Annotations.", "type": "object", "properties": { "branchNames": { "description": "Gets or sets branches that should have annotations.", "type": "array", "items": { "type": "string" }, "x-ms-identifiers": [] }, "annotateDefaultBranch": { "$ref": "#/definitions/AnnotateDefaultBranchState" } } } }, "parameters": { "SecurityConnectorName": { "in": "path", "name": "securityConnectorName", "description": "The security connector name.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "OrgName": { "in": "path", "name": "orgName", "description": "The Azure DevOps organization name.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "ProjectName": { "in": "path", "name": "projectName", "description": "The project name.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "RepoName": { "in": "path", "name": "repoName", "description": "The repository name.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "OwnerName": { "in": "path", "name": "ownerName", "description": "The GitHub owner name.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "GroupFQName": { "in": "path", "name": "groupFQName", "description": "The GitLab group fully-qualified name.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "OperationResultId": { "in": "path", "name": "operationResultId", "description": "The operation result Id.", "required": true, "type": "string", "x-ms-parameter-location": "method" } }, "securityDefinitions": { "azure_auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" }, "description": "Azure Active Directory OAuth2 Flow" } }, "security": [ { "azure_auth": [ "user_impersonation" ] } ] }