Impacted Resources - Get By Tenant Id

Service:

Resource Health

Version d’API:

2025-05-01

Obtient la ressource affectée spécifique dans le locataire par un événement.

GET https://management.azure.com/providers/Microsoft.ResourceHealth/events/{eventTrackingId}/impactedResources/{impactedResourceName}?api-version=2025-05-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
eventTrackingId	path	True	string	ID d’événement qui identifie de manière unique l’événement ServiceHealth.
impactedResourceName	path	True	string pattern: ^[^*#&+:<>%?]+$	Nom de la ressource affectée.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	eventImpactedResource	Opération Azure terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

ImpactedResourcesGet

Exemple de requête

HTTP

GET https://management.azure.com/providers/Microsoft.ResourceHealth/events/BC_1-FXZ/impactedResources/abc-123-ghj-456?api-version=2025-05-01

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.resourcehealth import ResourceHealthMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resourcehealth
# USAGE
    python impacted_resources_get_by_tenant_id.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ResourceHealthMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.impacted_resources.get_by_tenant_id(
        event_tracking_id="BC_1-FXZ",
        impacted_resource_name="abc-123-ghj-456",
    )
    print(response)


# x-ms-original-file: 2025-05-01/ImpactedResources_GetByTenantId.json
if __name__ == "__main__":
    main()

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

Go

package armresourcehealth_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resourcehealth/armresourcehealth"
)

// Generated from example definition: 2025-05-01/ImpactedResources_GetByTenantId.json
func ExampleImpactedResourcesClient_GetByTenantID() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armresourcehealth.NewClientFactory("<subscriptionID>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewImpactedResourcesClient().GetByTenantID(ctx, "BC_1-FXZ", "abc-123-ghj-456", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armresourcehealth.ImpactedResourcesClientGetByTenantIDResponse{
	// 	EventImpactedResource: armresourcehealth.EventImpactedResource{
	// 		Name: to.Ptr("abc-123-ghj-456"),
	// 		Type: to.Ptr("Microsoft.ResourceHealth/events/impactedResources"),
	// 		ID: to.Ptr("providers/Microsoft.ResourceHealth/events/BC_1-FXZ/impactedResources/abc-123-ghj-456"),
	// 		Properties: &armresourcehealth.EventImpactedResourceProperties{
	// 			TargetRegion: to.Ptr("westus"),
	// 			TargetResourceID: to.Ptr("{resourceId}"),
	// 			TargetResourceType: to.Ptr("Microsoft.Compute/VirtualMachines"),
	// 		},
	// 	},
	// }
}

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

JavaScript

const { MicrosoftResourceHealth } = require("@azure/arm-resourcehealth");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to gets the specific impacted resource in the tenant by an event.
 *
 * @summary gets the specific impacted resource in the tenant by an event.
 * x-ms-original-file: 2025-05-01/ImpactedResources_GetByTenantId.json
 */
async function impactedResourcesGet() {
  const credential = new DefaultAzureCredential();
  const client = new MicrosoftResourceHealth(credential);
  const result = await client.impactedResources.getByTenantId("BC_1-FXZ", "abc-123-ghj-456");
  console.log(result);
}

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

Exemple de réponse

Code d’état:

200

{
  "name": "abc-123-ghj-456",
  "type": "Microsoft.ResourceHealth/events/impactedResources",
  "id": "providers/Microsoft.ResourceHealth/events/BC_1-FXZ/impactedResources/abc-123-ghj-456",
  "properties": {
    "targetRegion": "westus",
    "targetResourceId": "{resourceId}",
    "targetResourceType": "Microsoft.Compute/VirtualMachines"
  }
}

Définitions

Nom	Description
ErrorResponse	Détails de l’erreur.
eventImpactedResource	Ressource affectée pour un événement.
keyValueItem	Tuple de valeur de clé.

ErrorResponse

Objet

Détails de l’erreur.

Nom	Type	Description
code	string	Code d’erreur.
details	string	Détails de l’erreur.
message	string	Message d’erreur.

eventImpactedResource

Objet

Ressource affectée pour un événement.

Nom	Type	Description
id	string (arm-id)	Azure Resource Manager Identity pour la ressource availabilityStatuses.
location	string	Azure Resource Manager géolocalisation de la ressource.
name	string
properties.info	keyValueItem[]	Informations supplémentaires
properties.targetRegion	string	Nom de la région de ressource affectée.
properties.targetResourceId	string	Identité pour la ressource au sein de Microsoft Cloud.
properties.targetResourceType	string	Type de ressource dans Microsoft Cloud.
type	string	Microsoft. RessourceSanté/DisponibilitéStatuts.

keyValueItem

Objet

Tuple de valeur de clé.

Nom	Type	Description
key	string	Clé du tuple.
value	string	Valeur du tuple.