Capability Types - Get

Serviço:

Chaos Studio

Versão da API:

2025-01-01

Obtenha um recurso Tipo de capacidade para determinado tipo de destino e local.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
capabilityTypeName	path	True	string pattern: ^[a-zA-Z0-9\-\.]+-\d\.\d$	Cadeia de caracteres que representa um nome de recurso Tipo de Capacidade.
location	path	True	string minLength: 1	O nome da região do Azure.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
targetTypeName	path	True	string pattern: ^[a-zA-Z0-9_\-\.]+$	Cadeia de caracteres que representa um nome de recurso Tipo de Destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	CapabilityType	Operação do Azure concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

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

Pedido de amostra

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

Resposta da amostra

Código de estado:

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"
    ]
  }
}

Definições

Name	Description
CapabilityType	Modelo que representa um recurso Tipo de Capacidade.
CapabilityTypePropertiesRuntimeProperties	Propriedades de tempo de execução deste tipo de capacidade.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
systemData	Metadados referentes à criação e última modificação do recurso.

CapabilityType

Object

Modelo que representa um recurso Tipo de Capacidade.

Name	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.azureRbacActions	string[]	Controle as ações do plano necessárias para executar o tipo de capacidade.
properties.azureRbacDataActions	string[]	Ações do plano de dados necessárias para executar o tipo de capacidade.
properties.description	string	Cadeia de caracteres localizada da descrição.
properties.displayName	string	Cadeia de caracteres localizada do nome para exibição.
properties.kind	string	String do tipo deste tipo de capacidade.
properties.parametersSchema	string maxLength: 2048	URL para recuperar o esquema JSON dos parâmetros Capability Type.
properties.publisher	string	Cadeia de caracteres do Publisher que este Tipo de Capacidade estende.
properties.requiredAzureRoleDefinitionIds	string[]	Ids de Definição de Função do Azure necessárias para executar o tipo de capacidade.
properties.runtimeProperties	CapabilityTypePropertiesRuntimeProperties	Propriedades de tempo de execução deste tipo de capacidade.
properties.targetType	string	String do tipo de destino que este tipo de capacidade estende.
properties.urn	string maxLength: 2048	String da URN para este tipo de capacidade.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

CapabilityTypePropertiesRuntimeProperties

Object

Propriedades de tempo de execução deste tipo de capacidade.

Name	Tipo	Description
kind	string	String do tipo de ação do recurso (contínua ou discreta).

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.