Azure DevOps Projects - Get

Ссылка

Служба:: Defender for Cloud

Версия API:: 2024-05-15-preview

Возвращает отслеживаемый ресурс проекта Azure DevOps.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}?api-version=2024-05-15-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
orgName	path	True	string	Имя организации Azure DevOps.
projectName	path	True	string	Имя проекта.
resourceGroupName	path	True	string	Имя группы ресурсов. Имя не учитывает регистр.
securityConnectorName	path	True	string	Имя соединителя безопасности.
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	AzureDevOpsProject	Предоставляет сведения о проекте Azure DevOps
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Get_AzureDevOpsProjects

GET https://management.azure.com/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/azureDevOpsOrgs/myAzDevOpsOrg/projects/myAzDevOpsProject?api-version=2024-05-15-preview


/**
 * Samples for AzureDevOpsProjects Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2024-05-15-preview/examples/
     * SecurityConnectorsDevOps/GetAzureDevOpsProjects_example.json
     */
    /**
     * Sample code: Get_AzureDevOpsProjects.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getAzureDevOpsProjects(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.azureDevOpsProjects().getWithResponse("myRg", "mySecurityConnectorName", "myAzDevOpsOrg",
            "myAzDevOpsProject", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Пример ответа

Код состояния:: 200

{
  "properties": {
    "parentOrgName": "myAzDevOpsOrg",
    "projectId": "9ebbed8f-a9cc-405f-a647-b235e22179de",
    "onboardingState": "Onboarded",
    "actionableRemediation": {
      "state": "Enabled"
    },
    "provisioningState": "Succeeded"
  },
  "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/azureDevOpsOrgs/myAzDevOpsOrg/projects/myAzDevOpsProject",
  "name": "myAzDevOpsProject",
  "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs/projects"
}

Определения

Имя	Описание
ActionableRemediation	Полезные данные конфигурации для заметок pr.
ActionableRemediationState	Параметр ActionableRemediation. Нет — параметр никогда не был задан. Включено . ActionableRemediation включен. Отключено — ActionableRemediation отключен.
AnnotateDefaultBranchState	Настройка заметок PR в ветви по умолчанию. Включено. Заметки pr включены в ветви ресурса по умолчанию. Отключены— заметки pr отключены в ветви ресурса по умолчанию.
AzureDevOpsProject	Ресурс Проекта Azure DevOps.
AzureDevOpsProjectProperties	Свойства Проекта Azure DevOps.
CategoryConfiguration	Уровень серьезности для конфигурации категории для заметок PR.
createdByType	Тип удостоверения, создавшего ресурс.
DevOpsProvisioningState	Состояние подготовки ресурса. Ожидание — ожидание подготовки. Сбой — сбой подготовки. Успешно выполнено — успешная подготовка. Отменено . Подготовка отменена. PendingDeletion — ожидание удаления. УдалениеSuccess — удаление успешно. УдалениеFailure — сбой удаления.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
InheritFromParentState	Параметры обновления. Включено. Ресурс должен наследовать конфигурации от родительского элемента. Отключен. Ресурс не должен наследовать конфигурации от родительского элемента.
OnboardingState	Сведения о состоянии подключения ресурсов во всех соединителях. ПодключениеByOtherConnector — этот ресурс уже подключен к другому соединителю. Это применимо только к ресурсам верхнего уровня. Подключен — этот ресурс уже подключен указанным соединителем. NotOnboarded — этот ресурс не был подключен к любому соединителю. NotApplicable — состояние подключения неприменимо к текущей конечной точке.
RuleCategory	Категории правил. Код — результаты сканирования кода. Результаты сканирования артефактов. Результаты сканирования зависимостей. Результаты IaC. Результаты сканирования секретов. Результаты сканирования контейнеров.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
TargetBranchConfiguration	Конфигурация ветви репозитория для заметок pr.

ActionableRemediation

Полезные данные конфигурации для заметок pr.

Имя	Тип	Описание
branchConfiguration	TargetBranchConfiguration	Конфигурация ветви репозитория для заметок pr.
categoryConfigurations	CategoryConfiguration[]	Возвращает или задает список категорий и уровней серьезности.
inheritFromParentState	InheritFromParentState	Параметры обновления. Включено. Ресурс должен наследовать конфигурации от родительского элемента. Отключен. Ресурс не должен наследовать конфигурации от родительского элемента.
state	ActionableRemediationState	Параметр ActionableRemediation. Нет — параметр никогда не был задан. Включено . ActionableRemediation включен. Отключено — ActionableRemediation отключен.

ActionableRemediationState

Параметр ActionableRemediation. Нет — параметр никогда не был задан. Включено . ActionableRemediation включен. Отключено — ActionableRemediation отключен.

Имя	Тип	Описание
Disabled	string
Enabled	string
None	string

AnnotateDefaultBranchState

Настройка заметок PR в ветви по умолчанию.

Включено. Заметки pr включены в ветви ресурса по умолчанию. Отключены— заметки pr отключены в ветви ресурса по умолчанию.

Имя	Тип	Описание
Disabled	string
Enabled	string

AzureDevOpsProject

Ресурс Проекта Azure DevOps.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties	AzureDevOpsProjectProperties	Свойства Проекта Azure DevOps.
systemData	systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

AzureDevOpsProjectProperties

Свойства Проекта Azure DevOps.

Имя	Тип	Описание
actionableRemediation	ActionableRemediation	Полезные данные конфигурации для заметок pr.
onboardingState	OnboardingState	Сведения о состоянии подключения ресурсов во всех соединителях. ПодключениеByOtherConnector — этот ресурс уже подключен к другому соединителю. Это применимо только к ресурсам верхнего уровня. Подключен — этот ресурс уже подключен указанным соединителем. NotOnboarded — этот ресурс не был подключен к любому соединителю. NotApplicable — состояние подключения неприменимо к текущей конечной точке.
parentOrgName	string	Возвращает или задает родительское имя организации Azure DevOps.
projectId	string	Возвращает или задает идентификатор проекта Azure DevOps.
provisioningState	DevOpsProvisioningState	Состояние подготовки ресурса. Ожидание — ожидание подготовки. Сбой — сбой подготовки. Успешно выполнено — успешная подготовка. Отменено . Подготовка отменена. PendingDeletion — ожидание удаления. УдалениеSuccess — удаление успешно. УдалениеFailure — сбой удаления.
provisioningStatusMessage	string	Возвращает сообщение о состоянии ресурса.
provisioningStatusUpdateTimeUtc	string	Возвращает время последнего проверки ресурса.

CategoryConfiguration

Уровень серьезности для конфигурации категории для заметок PR.

Имя	Тип	Описание
category	RuleCategory	Категории правил. Код — результаты сканирования кода. Результаты сканирования артефактов. Результаты сканирования зависимостей. Результаты IaC. Результаты сканирования секретов. Результаты сканирования контейнеров.
minimumSeverityLevel	string	Возвращает или задает минимальный уровень серьезности для данной категории.

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

DevOpsProvisioningState

Состояние подготовки ресурса.

Ожидание — ожидание подготовки. Сбой — сбой подготовки. Успешно выполнено — успешная подготовка. Отменено . Подготовка отменена. PendingDeletion — ожидание удаления. УдалениеSuccess — удаление успешно. УдалениеFailure — сбой удаления.

Имя	Тип	Описание
Canceled	string
DeletionFailure	string
DeletionSuccess	string
Failed	string
Pending	string
PendingDeletion	string
Succeeded	string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

InheritFromParentState

Параметры обновления.

Включено. Ресурс должен наследовать конфигурации от родительского элемента. Отключен. Ресурс не должен наследовать конфигурации от родительского элемента.

Имя	Тип	Описание
Disabled	string
Enabled	string

OnboardingState

Сведения о состоянии подключения ресурсов во всех соединителях.

ПодключениеByOtherConnector — этот ресурс уже подключен к другому соединителю. Это применимо только к ресурсам верхнего уровня. Подключен — этот ресурс уже подключен указанным соединителем. NotOnboarded — этот ресурс не был подключен к любому соединителю. NotApplicable — состояние подключения неприменимо к текущей конечной точке.

Имя	Тип	Описание
NotApplicable	string
NotOnboarded	string
Onboarded	string
OnboardedByOtherConnector	string

RuleCategory

Категории правил. Код — результаты сканирования кода. Результаты сканирования артефактов. Результаты сканирования зависимостей. Результаты IaC. Результаты сканирования секретов. Результаты сканирования контейнеров.

Имя	Тип	Описание
Artifacts	string
Code	string
Containers	string
Dependencies	string
IaC	string
Secrets	string

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

TargetBranchConfiguration

Конфигурация ветви репозитория для заметок pr.

Имя	Тип	Описание
annotateDefaultBranch	AnnotateDefaultBranchState	Настройка заметок PR в ветви по умолчанию. Включено. Заметки pr включены в ветви ресурса по умолчанию. Отключены— заметки pr отключены в ветви ресурса по умолчанию.
branchNames	string[]	Возвращает или задает ветви, которые должны содержать заметки.

Имя

Тип

Описание

annotateDefaultBranch

AnnotateDefaultBranchState

Настройка заметок PR в ветви по умолчанию.

branchNames

string[]

Возвращает или задает ветви, которые должны содержать заметки.

Поделиться через

Azure DevOps Projects - Get

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

Get_AzureDevOpsProjects

Образец запроса

Пример ответа

Определения

ActionableRemediation

ActionableRemediationState

AnnotateDefaultBranchState

AzureDevOpsProject

AzureDevOpsProjectProperties

CategoryConfiguration

createdByType

DevOpsProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InheritFromParentState

OnboardingState

RuleCategory

systemData

TargetBranchConfiguration

Дополнительные ресурсы