AFD Origin Groups - Get

Service:: Front Door Service

Version d'API:: 2025-04-15

Obtient un groupe d’origine existant dans un profil.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}?api-version=2025-04-15

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
originGroupName	path	True	string	Nom du groupe d’origine unique dans le point de terminaison.
profileName	path	True	string minLength: 1 maxLength: 260 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9])$	Nom d’Azure Front Door Standard ou d’Azure Front Door Premium qui est unique dans le groupe de ressources.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	AFDOriginGroup	Ok
Other Status Codes	ErrorResponse	Réponse d’erreur Azure Front Door décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

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

AFDOriginGroups_Get

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/origingroup1?api-version=2025-04-15

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Cdn.Models;
using Azure.ResourceManager.Cdn;

// Generated from example definition: specification/cdn/resource-manager/Microsoft.Cdn/stable/2025-04-15/examples/AFDOriginGroups_Get.json
// this example is just showing the usage of "FrontDoorOriginGroups_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 ProfileResource created on azure
// for more information of creating ProfileResource, please refer to the document of ProfileResource
string subscriptionId = "subid";
string resourceGroupName = "RG";
string profileName = "profile1";
ResourceIdentifier profileResourceId = ProfileResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName);
ProfileResource profile = client.GetProfileResource(profileResourceId);

// get the collection of this FrontDoorOriginGroupResource
FrontDoorOriginGroupCollection collection = profile.GetFrontDoorOriginGroups();

// invoke the operation
string originGroupName = "origingroup1";
NullableResponse<FrontDoorOriginGroupResource> response = await collection.GetIfExistsAsync(originGroupName);
FrontDoorOriginGroupResource 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
    FrontDoorOriginGroupData 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

Exemple de réponse

Code d’état:: 200

{
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1",
  "type": "Microsoft.Cdn/profiles/origingroups",
  "name": "origingroup1",
  "properties": {
    "loadBalancingSettings": {
      "sampleSize": 3,
      "successfulSamplesRequired": 3,
      "additionalLatencyInMilliseconds": 1000
    },
    "healthProbeSettings": {
      "probePath": "/path1",
      "probeRequestType": "HEAD",
      "probeProtocol": "Http",
      "probeIntervalInSeconds": 10
    },
    "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5,
    "provisioningState": "Succeeded",
    "deploymentStatus": "NotStarted"
  }
}

Définitions

Nom	Description
AFDOriginGroup	Le groupe AFDOrigin comprenant des origines est utilisé pour l’équilibrage de charge aux origines lorsque le contenu ne peut pas être servi à partir d’Azure Front Door.
AfdProvisioningState	État d’approvisionnement
createdByType	Type d’identité qui a créé la ressource.
DeploymentStatus
EnabledState	Indique s’il faut activer l’utilisation de cette règle. Les valeurs autorisées sont « Enabled » ou « Disabled »
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
HealthProbeParameters	Objet JSON qui contient les propriétés permettant d’envoyer des sondes d’intégrité à l’origine.
HealthProbeRequestType	Type de demande de sonde d’intégrité effectuée.
LoadBalancingSettingsParameters	Round-Robin paramètres d’équilibrage de charge pour un pool principal
ProbeProtocol	Protocole à utiliser pour la sonde d’intégrité.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

AFDOriginGroup

Object

Le groupe AFDOrigin comprenant des origines est utilisé pour l’équilibrage de charge aux origines lorsque le contenu ne peut pas être servi à partir d’Azure Front Door.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties.deploymentStatus	DeploymentStatus
properties.healthProbeSettings	HealthProbeParameters	Paramètres de la sonde d’intégrité à l’origine utilisée pour déterminer l’intégrité de l’origine.
properties.loadBalancingSettings	LoadBalancingSettingsParameters	Paramètres d’équilibrage de charge pour un pool principal
properties.profileName	string	Nom du profil qui contient le groupe d’origine.
properties.provisioningState	AfdProvisioningState	État d’approvisionnement
properties.sessionAffinityState	EnabledState	Indique s’il faut autoriser l’affinité de session sur cet hôte. Les options valides sont « Activé » ou « Désactivé »
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes	integer (int32) minimum: 0 maximum: 50	Temps en minutes pour déplacer le trafic vers le point de terminaison progressivement lorsqu’un point de terminaison non sain est sain ou qu’un nouveau point de terminaison est ajouté. La valeur par défaut est de 10 minutes. Cette propriété n’est actuellement pas prise en charge.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

AfdProvisioningState

Énumération

État d’approvisionnement

Valeur	Description
Creating
Deleting
Failed
Succeeded
Updating

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
Application
Key
ManagedIdentity
User

DeploymentStatus

Énumération

Valeur	Description
Failed
InProgress
NotStarted
Succeeded

EnabledState

Énumération

Indique s’il faut activer l’utilisation de cette règle. Les valeurs autorisées sont « Enabled » ou « Disabled »

Valeur	Description
Disabled
Enabled

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

HealthProbeParameters

Object

Objet JSON qui contient les propriétés permettant d’envoyer des sondes d’intégrité à l’origine.

Nom	Type	Description
probeIntervalInSeconds	integer (int32) minimum: 1 maximum: 255	Nombre de secondes entre les sondes d’intégrité. La valeur par défaut est 240sec.
probePath	string	Chemin relatif à l’origine utilisée pour déterminer l’intégrité de l’origine.
probeProtocol	ProbeProtocol	Protocole à utiliser pour la sonde d’intégrité.
probeRequestType	HealthProbeRequestType	Type de demande de sonde d’intégrité effectuée.

HealthProbeRequestType

Énumération

Type de demande de sonde d’intégrité effectuée.

Valeur	Description
GET
HEAD
NotSet

LoadBalancingSettingsParameters

Object

Round-Robin paramètres d’équilibrage de charge pour un pool principal

Nom	Type	Description
additionalLatencyInMilliseconds	integer (int32)	Latence supplémentaire en millisecondes pour que les sondes tombent dans le compartiment de latence le plus bas
sampleSize	integer (int32)	Nombre d’exemples à prendre en compte pour les décisions d’équilibrage de charge
successfulSamplesRequired	integer (int32)	Nombre d’échantillons au cours de la période d’échantillonnage qui doivent réussir

ProbeProtocol

Énumération

Protocole à utiliser pour la sonde d’intégrité.

Valeur	Description
Http
Https
NotSet

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Partager via

AFD Origin Groups - Get

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

AFDOriginGroups_Get

Exemple de requête

Exemple de réponse

Définitions

AFDOriginGroup

AfdProvisioningState

createdByType

DeploymentStatus

EnabledState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HealthProbeParameters

HealthProbeRequestType

LoadBalancingSettingsParameters

ProbeProtocol

systemData