Capability Types - Get

Service:

Chaos Studio

API-versie:

2025-01-01

Haal een resource van het mogelijkheidstype op voor het opgegeven doeltype en de opgegeven locatie.

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

URI-parameters

Name	In	Vereist	Type	Description
capabilityTypeName	path	True	string pattern: ^[a-zA-Z0-9\-\.]+-\d\.\d$	Tekenreeks die de resourcenaam van een mogelijkheidstype vertegenwoordigt.
location	path	True	string minLength: 1	De naam van de Azure-regio.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
targetTypeName	path	True	string pattern: ^[a-zA-Z0-9_\-\.]+$	Tekenreeks die de resourcenaam van het doeltype vertegenwoordigt.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	CapabilityType	De Azure-bewerking is voltooid.
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

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

Voorbeeldaanvraag

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Chaos;

// Generated from example definition: 2025-01-01/CapabilityTypes_Get.json
// this example is just showing the usage of "CapabilityType_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ChaosTargetMetadataResource created on azure
// for more information of creating ChaosTargetMetadataResource, please refer to the document of ChaosTargetMetadataResource
string subscriptionId = "6b052e15-03d3-4f17-b2e1-be7f07588291";
AzureLocation location = new AzureLocation("westus2");
string targetTypeName = "Microsoft-VirtualMachine";
ResourceIdentifier chaosTargetMetadataResourceId = ChaosTargetMetadataResource.CreateResourceIdentifier(subscriptionId, location, targetTypeName);
ChaosTargetMetadataResource chaosTargetMetadata = client.GetChaosTargetMetadataResource(chaosTargetMetadataResourceId);

// get the collection of this ChaosCapabilityMetadataResource
ChaosCapabilityMetadataCollection collection = chaosTargetMetadata.GetAllChaosCapabilityMetadata();

// invoke the operation
string capabilityTypeName = "Shutdown-1.0";
NullableResponse<ChaosCapabilityMetadataResource> response = await collection.GetIfExistsAsync(capabilityTypeName);
ChaosCapabilityMetadataResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ChaosCapabilityMetadataData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
CapabilityType	Model dat een mogelijkheidstyperesource vertegenwoordigt.
CapabilityTypePropertiesRuntimeProperties	Runtime-eigenschappen van dit mogelijkheidstype.
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

CapabilityType

Object

Model dat een mogelijkheidstyperesource vertegenwoordigt.

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties.azureRbacActions	string[]	Besturingsvlakacties die nodig zijn om het mogelijkheidstype uit te voeren.
properties.azureRbacDataActions	string[]	Gegevensvlakacties die nodig zijn om het mogelijkheidstype uit te voeren.
properties.description	string	Gelokaliseerde tekenreeks van de beschrijving.
properties.displayName	string	Gelokaliseerde tekenreeks van de weergavenaam.
properties.kind	string	Tekenreeks van het type van dit mogelijkheidstype.
properties.parametersSchema	string maxLength: 2048	URL voor het ophalen van het JSON-schema van de parameters van het mogelijkheidstype.
properties.publisher	string	Tekenreeks van de uitgever die dit mogelijkheidstype uitbreidt.
properties.requiredAzureRoleDefinitionIds	string[]	Vereiste Azure-roldefinitie-id's om het mogelijkheidstype uit te voeren.
properties.runtimeProperties	CapabilityTypePropertiesRuntimeProperties	Runtime-eigenschappen van dit mogelijkheidstype.
properties.targetType	string	Tekenreeks van het doeltype dat dit mogelijkheidstype uitbreidt.
properties.urn	string maxLength: 2048	Tekenreeks van de URN voor dit mogelijkheidstype.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

CapabilityTypePropertiesRuntimeProperties

Object

Runtime-eigenschappen van dit mogelijkheidstype.

Name	Type	Description
kind	string	Tekenreeks van het type actietype van de resource (doorlopend of discreet).

createdByType

Opsomming

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.