Capability Types - Get

Служба:

Chaos Studio

Версия API:

2025-01-01

Получение ресурса типа возможностей для заданного типа целевого объекта и расположения.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{location}/targetTypes/{targetTypeName}/capabilityTypes/{capabilityTypeName}?api-version=2025-01-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
capabilityTypeName	path	True	string pattern: ^[a-zA-Z0-9\-\.]+-\d\.\d$	Строка, представляющая имя ресурса типа возможностей.
location	path	True	string minLength: 1	Имя региона Azure.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть UUID.
targetTypeName	path	True	string pattern: ^[a-zA-Z0-9_\-\.]+$	Строка, представляющая имя ресурса целевого типа.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	CapabilityType	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

Get a Capability Type for a virtual machine Target resource on westus2 location.

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

HTTP

GET https://management.azure.com/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/providers/Microsoft.Chaos/locations/westus2/targetTypes/Microsoft-VirtualMachine/capabilityTypes/Shutdown-1.0?api-version=2025-01-01

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

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

200

{
  "name": "Shutdown-1.0",
  "type": "Microsoft.Chaos/locations/targetTypes/capabilityTypes",
  "id": "/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/providers/Microsoft.Chaos/locations/westus2/targetTypes/Microsoft-VirtualMachine/capabilityTypes/Shutdown-1.0",
  "properties": {
    "description": "Shutdown an Azure Virtual Machine for a defined period of time.",
    "displayName": "Shutdown VM",
    "kind": "fault",
    "parametersSchema": "https://schema.centralus.chaos-prod.azure.com/targets/Microsoft-VirtualMachine/capabilities/Shutdown-1.0.json",
    "publisher": "Microsoft",
    "runtimeProperties": {
      "kind": "continuous"
    },
    "targetType": "VirtualMachine",
    "urn": "urn:csci:microsoft:virtualMachine:shutdown/1.0",
    "azureRbacActions": [
      "Microsoft.Compute/virtualMachines/poweroff/action",
      "Microsoft.Compute/virtualMachines/start/action",
      "Microsoft.Compute/virtualMachines/instanceView/read",
      "Microsoft.Compute/virtualMachines/read",
      "Microsoft.Compute/locations/operations/read"
    ],
    "requiredAzureRoleDefinitionIds": [
      "acdd72a7-3385-48ef-bd42-f606fba81ae0"
    ]
  }
}

Определения

Имя	Описание
CapabilityType	Модель, представляющая ресурс типа возможностей.
CapabilityTypePropertiesRuntimeProperties	Свойства среды выполнения этого типа возможности.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

CapabilityType

Object

Модель, представляющая ресурс типа возможностей.

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса
properties.azureRbacActions	string[]	Действия уровня управления, необходимые для выполнения типа возможностей.
properties.azureRbacDataActions	string[]	Действия плоскости данных, необходимые для выполнения типа возможностей.
properties.description	string	Локализованная строка описания.
properties.displayName	string	Локализованная строка отображаемого имени.
properties.kind	string	Строка типа этой возможности.
properties.parametersSchema	string maxLength: 2048	URL-адрес для получения схемы JSON параметров типа возможностей.
properties.publisher	string	Строка издателя, который расширяет этот тип возможностей.
properties.requiredAzureRoleDefinitionIds	string[]	Обязательные идентификаторы определения ролей Azure для выполнения типа возможностей.
properties.runtimeProperties	CapabilityTypePropertiesRuntimeProperties	Свойства среды выполнения этого типа возможности.
properties.targetType	string	Строка целевого типа, который расширяет этот тип возможности.
properties.urn	string maxLength: 2048	Строка URN для этого типа возможностей.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

CapabilityTypePropertiesRuntimeProperties

Object

Свойства среды выполнения этого типа возможности.

Имя	Тип	Описание
kind	string	Строка типа действия ресурса (непрерывная или дискретная).

createdByType

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

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

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

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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

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

ErrorResponse

Object

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

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

systemData

Object

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

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