Azure DevOps Orgs - List Available

Служба:: Defender for Cloud

Версия API:: 2024-04-01

Возвращает список всех организаций Azure DevOps, доступных маркером пользователя, используемым соединителем.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/listAvailableAzureDevOpsOrgs?api-version=2024-04-01

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	AzureDevOpsOrgListResponse	Содержит список сведений о организации 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	олицетворения учетной записи пользователя

Примеры

ListAvailable_AzureDevOpsOrgs

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

HTTP

POST https://management.azure.com/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/listAvailableAzureDevOpsOrgs?api-version=2024-04-01

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

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

{
  "value": [
    {
      "properties": {
        "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",
      "name": "myAzDevOpsOrg",
      "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs"
    },
    {
      "properties": {
        "onboardingState": "OnboardedByOtherConnector",
        "actionableRemediation": {
          "state": "Enabled"
        },
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/azureDevOpsOrgs/anotherOrg",
      "name": "anotherOrg",
      "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs"
    },
    {
      "properties": {
        "onboardingState": "NotOnboarded",
        "actionableRemediation": {
          "state": "None"
        }
      },
      "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/azureDevOpsOrgs/notOnboardedOrg",
      "name": "notOnboardedOrg",
      "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs"
    }
  ]
}

Определения

Имя	Описание
ActionableRemediation	Полезные данные конфигурации для заметок pr.
ActionableRemediationState	Параметр ActionableRemediation. Нет — параметр никогда не был задан. Включено . ActionableRemediation включен. Отключено — ActionableRemediation отключен.
AnnotateDefaultBranchState	Настройка заметок PR в ветви по умолчанию. Включено. Заметки pr включены в ветви ресурса по умолчанию. Отключены— заметки pr отключены в ветви ресурса по умолчанию.
AzureDevOpsOrg	Ресурс Azure DevOps Organization.
AzureDevOpsOrgListResponse	Список ресурсов RP, поддерживающих разбиение на страницы.
AzureDevOpsOrgProperties	Свойства Организации 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 отключен.

Значение	Описание
None
Disabled
Enabled

AnnotateDefaultBranchState

Перечисление

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

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

Значение	Описание
Disabled
Enabled

AzureDevOpsOrg

Объект

Ресурс Azure DevOps Organization.

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

AzureDevOpsOrgListResponse

Объект

Список ресурсов RP, поддерживающих разбиение на страницы.

Имя	Тип	Описание
nextLink	string	Возвращает или задает следующую ссылку, чтобы прокрутить результаты.
value	AzureDevOpsOrg[]	Возвращает или задает список ресурсов.

AzureDevOpsOrgProperties

Объект

Свойства Организации Azure DevOps.

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

CategoryConfiguration

Объект

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

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

createdByType

Перечисление

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

Значение	Описание
User
Application
ManagedIdentity
Key

DevOpsProvisioningState

Перечисление

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

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

Значение	Описание
Succeeded
Failed
Canceled
Pending
PendingDeletion
DeletionSuccess
DeletionFailure

ErrorAdditionalInfo

Объект

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

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

ErrorDetail

Объект

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

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

ErrorResponse

Объект

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

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

InheritFromParentState

Перечисление

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

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

Значение	Описание
Disabled
Enabled

OnboardingState

Перечисление

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

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

Значение	Описание
NotApplicable
OnboardedByOtherConnector
Onboarded
NotOnboarded

RuleCategory

Перечисление

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

Значение	Описание
Code
Artifacts
Dependencies
Secrets
IaC
Containers

systemData

Объект

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

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

TargetBranchConfiguration

Объект

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

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

Имя

Тип

Описание

annotateDefaultBranch

AnnotateDefaultBranchState

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

branchNames

string[]

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

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

Azure DevOps Orgs - List Available

Параметры URI

Ответы

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

azure_auth

Области

Примеры

ListAvailable_AzureDevOpsOrgs

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

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

Определения

ActionableRemediation

ActionableRemediationState

AnnotateDefaultBranchState

AzureDevOpsOrg

AzureDevOpsOrgListResponse

AzureDevOpsOrgProperties

CategoryConfiguration

createdByType

DevOpsProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InheritFromParentState

OnboardingState

RuleCategory

systemData

TargetBranchConfiguration