Autoscale Settings - List By Resource Group

Répertorie les paramètres de mise à l’échelle automatique pour un groupe de ressources

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings?api-version=2015-04-01

Paramètres URI

Name In Required Type Description
resourceGroupName
path True
  • string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

subscriptionId
path True
  • string

ID de l’abonnement cible.

api-version
query True
  • string

Version de l’API à utiliser pour cette opération.

Réponses

Name Type Description
200 OK

Demande réussie de la liste des paramètres de mise à l’échelle automatique

Other Status Codes

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Exemples

List autoscale settings

Sample Request

GET https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/TestingMetricsScaleSet/providers/Microsoft.Insights/autoscalesettings?api-version=2015-04-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/microsoft.insights/autoscalesettings/MySetting",
      "name": "MySetting",
      "type": "Microsoft.Insights/autoscaleSettings",
      "location": "West US",
      "tags": {
        "$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage"
      },
      "properties": {
        "profiles": [
          {
            "name": "adios",
            "capacity": {
              "minimum": "1",
              "maximum": "10",
              "default": "1"
            },
            "rules": [
              {
                "metricTrigger": {
                  "metricName": "Percentage CPU",
                  "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc",
                  "timeGrain": "PT1M",
                  "statistic": "Average",
                  "timeWindow": "PT5M",
                  "timeAggregation": "Average",
                  "operator": "GreaterThan",
                  "threshold": 10,
                  "dividePerInstance": false
                },
                "scaleAction": {
                  "direction": "Increase",
                  "type": "ChangeCount",
                  "value": "1",
                  "cooldown": "PT5M"
                }
              },
              {
                "metricTrigger": {
                  "metricName": "Percentage CPU",
                  "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc",
                  "timeGrain": "PT2M",
                  "statistic": "Average",
                  "timeWindow": "PT5M",
                  "timeAggregation": "Average",
                  "operator": "GreaterThan",
                  "threshold": 15,
                  "dividePerInstance": false
                },
                "scaleAction": {
                  "direction": "Decrease",
                  "type": "ChangeCount",
                  "value": "2",
                  "cooldown": "PT6M"
                }
              }
            ],
            "fixedDate": {
              "timeZone": "UTC",
              "start": "2015-03-05T14:00:00Z",
              "end": "2015-03-05T14:30:00Z"
            }
          },
          {
            "name": "saludos",
            "capacity": {
              "minimum": "1",
              "maximum": "10",
              "default": "1"
            },
            "rules": [
              {
                "metricTrigger": {
                  "metricName": "Percentage CPU",
                  "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc",
                  "timeGrain": "PT1M",
                  "statistic": "Average",
                  "timeWindow": "PT5M",
                  "timeAggregation": "Average",
                  "operator": "GreaterThan",
                  "threshold": 10,
                  "dividePerInstance": false
                },
                "scaleAction": {
                  "direction": "Increase",
                  "type": "ChangeCount",
                  "value": "1",
                  "cooldown": "PT5M"
                }
              },
              {
                "metricTrigger": {
                  "metricName": "Percentage CPU",
                  "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc",
                  "timeGrain": "PT2M",
                  "statistic": "Average",
                  "timeWindow": "PT5M",
                  "timeAggregation": "Average",
                  "operator": "GreaterThan",
                  "threshold": 15,
                  "dividePerInstance": false
                },
                "scaleAction": {
                  "direction": "Decrease",
                  "type": "ChangeCount",
                  "value": "2",
                  "cooldown": "PT6M"
                }
              }
            ],
            "recurrence": {
              "frequency": "Week",
              "schedule": {
                "timeZone": "UTC",
                "days": [
                  "1"
                ],
                "hours": [
                  5
                ],
                "minutes": [
                  15
                ]
              }
            }
          }
        ],
        "enabled": true,
        "name": "MySetting",
        "targetResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc",
        "notifications": [
          {
            "operation": "Scale",
            "email": {
              "sendToSubscriptionAdministrator": true,
              "sendToSubscriptionCoAdministrators": true,
              "customEmails": [
                "gu@ms.com",
                "ge@ns.net"
              ]
            },
            "webhooks": [
              {
                "serviceUri": "http://myservice.com",
                "properties": {}
              }
            ]
          }
        ]
      }
    }
  ],
  "nextLink": "https://management.azure.com/########-####-####-####-############$skiptoken=######"
}

Définitions

AutoscaleNotification

Notification de mise à l’échelle automatique.

AutoscaleProfile

Profil de mise à l’échelle automatique.

AutoscaleSettingResource

Ressource du paramètre de mise à l’échelle automatique.

AutoscaleSettingResourceCollection

Représente une collection de ressources de paramètre de mise à l’échelle automatique.

ComparisonOperationType

opérateur utilisé pour comparer les données de mesure et le seuil.

EmailNotification

Notification par courrier électronique d’un événement de mise à l’échelle automatique.

ErrorResponse

Décrit le format de la réponse d’erreur.

MetricStatisticType

type de statistiques de métrique. Manière dont les métriques de plusieurs instances sont combinées.

MetricTrigger

Déclencheur qui entraîne une action de mise à l'échelle.

OperationType

l’opération associée à la notification et sa valeur doivent être « Scale »

Recurrence

Heures récurrentes auxquelles ce profil commence. Cet élément n'est pas utilisé si l'élément FixedDate est utilisé.

RecurrenceFrequency

fréquence de périodicité. La fréquence à laquelle le profil de planification doit prendre effet. Cette valeur doit être Semaine, ce qui signifie que chaque semaine a le même ensemble de profils. Par exemple, pour définir une planification quotidienne, définissez planification sur tous les jours de la semaine. La propriété Frequency spécifie que la planification est répétée chaque semaine.

RecurrentSchedule

Contraintes de planification pour le moment où le profil commence.

ScaleAction

Paramètres de l’action de mise à l’échelle.

ScaleCapacity

Nombre d'instances qui peuvent être utilisées au cours de ce profil.

ScaleDirection

le sens de mise à l’échelle. Indique si l’action de mise à l’échelle augmente ou diminue le nombre d’instances.

ScaleRule

Règle qui fournit les déclencheurs et les paramètres de l’action de mise à l’échelle.

ScaleRuleMetricDimension

Spécifie une dimension de métrique de règle de mise à l’échelle automatique.

ScaleRuleMetricDimensionOperationType

opérateur de dimension. Seuls’Equals’et’NotEquals’sont pris en charge. 'Equals’étant égal à l’une des valeurs. 'NotEquals’n’est pas égal à toutes les valeurs

ScaleType

type d’action qui doit se produire lors du déclenchement de la règle de mise à l’échelle.

TimeAggregationType

type d’agrégation de temps. Détermine la façon dont les données collectées doivent être combinées au fil du temps. La valeur par défaut est Average.

TimeWindow

Date-heure spécifique pour le profil.

WebhookNotification

Notification webhook d’un événement de mise à l’échelle automatique.

AutoscaleNotification

Notification de mise à l’échelle automatique.

Name Type Description
email

notification par courrier électronique.

operation

l’opération associée à la notification et sa valeur doivent être « Scale »

webhooks

collection de notifications de webhook.

AutoscaleProfile

Profil de mise à l’échelle automatique.

Name Type Description
capacity

nombre d’instances qui peuvent être utilisées pendant ce profil.

fixedDate

Date et heure spécifiques pour le profil. Cet élément n'est pas utilisé si l'élément Recurrence est utilisé.

name
  • string

nom du profil.

recurrence

heures répétées auxquelles ce profil commence. Cet élément n'est pas utilisé si l'élément FixedDate est utilisé.

rules

collection de règles qui fournissent les déclencheurs et les paramètres de l’action de mise à l’échelle. Au plus 10 règles peuvent être spécifiées.

AutoscaleSettingResource

Ressource du paramètre de mise à l’échelle automatique.

Name Type Description
id
  • string

ID de ressource Azure

location
  • string

Emplacement de la ressource

name
  • string

Nom de la ressource Azure

properties.enabled
  • boolean

indicateur activé. Spécifie si la mise à l'échelle automatique est activée pour la ressource. La valeur par défaut est « true ».

properties.name
  • string

nom du paramètre de mise à l’échelle automatique.

properties.notifications

collection de notifications.

properties.profiles

collection de profils de mise à l’échelle automatique qui spécifient des paramètres de mise à l’échelle différents pour différentes périodes. Au plus 20 profils peuvent être spécifiés.

properties.targetResourceLocation
  • string

emplacement de la ressource à laquelle le paramètre de mise à l’échelle automatique doit être ajouté.

properties.targetResourceUri
  • string

identificateur de ressource de la ressource à laquelle le paramètre de mise à l’échelle automatique doit être ajouté.

tags
  • object

Balises de ressource

type
  • string

Type de ressource Azure

AutoscaleSettingResourceCollection

Représente une collection de ressources de paramètre de mise à l’échelle automatique.

Name Type Description
nextLink
  • string

URL pour obtenir le jeu de résultats suivant.

value

valeurs des ressources du paramètre de mise à l’échelle automatique.

ComparisonOperationType

opérateur utilisé pour comparer les données de mesure et le seuil.

Name Type Description
Equals
  • string
GreaterThan
  • string
GreaterThanOrEqual
  • string
LessThan
  • string
LessThanOrEqual
  • string
NotEquals
  • string

EmailNotification

Notification par courrier électronique d’un événement de mise à l’échelle automatique.

Name Type Description
customEmails
  • string[]

Liste des messages électroniques personnalisés. Cette valeur peut être null ou vide, auquel cas cet attribut sera ignoré.

sendToSubscriptionAdministrator
  • boolean

valeur indiquant s’il faut envoyer un e-mail à l’administrateur de l’abonnement.

sendToSubscriptionCoAdministrators
  • boolean

valeur indiquant s’il faut envoyer un e-mail aux coadministrateurs d’abonnement.

ErrorResponse

Décrit le format de la réponse d’erreur.

Name Type Description
code
  • string

Code d'erreur

message
  • string

Message d’erreur indiquant la raison de l’échec de l’opération.

MetricStatisticType

type de statistiques de métrique. Manière dont les métriques de plusieurs instances sont combinées.

Name Type Description
Average
  • string
Count
  • string
Max
  • string
Min
  • string
Sum
  • string

MetricTrigger

Déclencheur qui entraîne une action de mise à l'échelle.

Name Type Description
dimensions

Liste des conditions de dimension. Par exemple : [{« DimensionName » : « AppName », « Operator » : « Equals », « Values » : [« App1 »]}, {« DimensionName » : « Deployment », « Operator » : « Equals », « Values » : [« Default »]}].

dividePerInstance
  • boolean

valeur indiquant si la métrique doit être divisée par instance.

metricName
  • string

nom de la métrique qui définit ce que la règle analyse.

metricNamespace
  • string

espace de noms de la métrique qui définit ce que la règle analyse.

metricResourceLocation
  • string

emplacement de la ressource analysée par la règle.

metricResourceUri
  • string

identificateur de ressource de la ressource analysée par la règle.

operator

opérateur utilisé pour comparer les données de mesure et le seuil.

statistic

type de statistiques de métrique. Manière dont les métriques de plusieurs instances sont combinées.

threshold
  • number

seuil de la métrique qui déclenche l’action de mise à l’échelle.

timeAggregation

type d’agrégation de temps. Détermine la façon dont les données collectées doivent être combinées au fil du temps. La valeur par défaut est Average.

timeGrain
  • string

granularité des mesures analysées par la règle. Doit être l'une des valeurs prédéfinies renvoyées à partir des définitions de métriques pour la mesure. Doit être comprise entre 12 heures et 1 minute.

timeWindow
  • string

plage de temps pendant laquelle les données d’instance sont collectées. Cette valeur doit être supérieure au délai de collecte de mesures, qui peut varier d'une ressource à l'autre. Doit être comprise entre 12 heures et 5 minutes.

OperationType

l’opération associée à la notification et sa valeur doivent être « Scale »

Name Type Description
Scale
  • string

Recurrence

Heures récurrentes auxquelles ce profil commence. Cet élément n'est pas utilisé si l'élément FixedDate est utilisé.

Name Type Description
frequency

fréquence de périodicité. La fréquence à laquelle le profil de planification doit prendre effet. Cette valeur doit être Semaine, ce qui signifie que chaque semaine a le même ensemble de profils. Par exemple, pour définir une planification quotidienne, définissez planification sur tous les jours de la semaine. La propriété Frequency spécifie que la planification est répétée chaque semaine.

schedule

contraintes de planification pour le début du profil.

RecurrenceFrequency

fréquence de périodicité. La fréquence à laquelle le profil de planification doit prendre effet. Cette valeur doit être Semaine, ce qui signifie que chaque semaine a le même ensemble de profils. Par exemple, pour définir une planification quotidienne, définissez planification sur tous les jours de la semaine. La propriété Frequency spécifie que la planification est répétée chaque semaine.

Name Type Description
Day
  • string
Hour
  • string
Minute
  • string
Month
  • string
None
  • string
Second
  • string
Week
  • string
Year
  • string

RecurrentSchedule

Contraintes de planification pour le moment où le profil commence.

Name Type Description
days
  • string[]

collection de jours pendant lesquels le profil prend effet. Les valeurs possibles sont dimanche à samedi.

hours
  • integer[]

Collection d’heures auxquelles le profil prend effet. Les valeurs prises en charge sont comprises entre 0 et 23 sur 24 heures (les heures AM/PM ne sont pas prises en charge).

minutes
  • integer[]

Collection de minutes auxquelles le profil prend effet.

timeZone
  • string

fuseau horaire pour les heures du profil. Voici quelques exemples de fuseaux horaires valides : changement de date et heure standard, UTC-11, Hawaii, heure standard, heure standard du Pacifique (Mexique), heure standard du Pacifique, heure standard de la montagne, heure standard de la montagne (Mexique), heure standard de la montagne, heure d’hiver de l’Amérique centrale, heure standard centrale, heure du Centre des États-Unis, Canada, heure d’hiver du Pacifique, Est des États-Unis de l’est, heure d’hiver du Paraguay, heure d’hiver du Paraguay, heure d’hiver du Brésil Centre, heure d’hiver de l’ouest de l’Ouest, heure standard du Pacifique, heure d’hiver de l’Ouest, heure standard de l’Amérique du Sud, UTC-02, Mid-Atlantic de l’heure d’hiver, heure d’hiver des Açores, Heure standard du Cap-Vert, heure standard du Maroc, heure UTC, heure GMT, heure standard GMT, heure standard de Greenwich, heure d’hiver Europe centrale, heure standard de l’Europe de l’Ouest, heure standard de l’Europe centrale, heure standard de l’Afrique du Sud, heure standard de la côte de l’est, heure standard de l’Europe de l’est, Afrique du Sud, FLE, heure standard, Turquie, heure d’hiver, heure d’hiver Israël, heure standard de Libye, heure d’hiver arabe, heure d’hiver arabe, heure standard du Zone 3 Belarus, heure d’hiver de l’île de l’est, heure d’hiver de l’île de l’est, heure d’hiver du géorgien, heure d’hiver, heure d’hiver heure d’hiver Afghanistan, heure standard de l’asie de l’ouest, heure standard de iekaterinbourg, heure d’hiver Pakistan, inde, heure standard, Sri Lanka, heure standard du népal, heure standard de l’asie du nord, heure standard du SE Bangladesh, heure standard de l’asie du nord, heure du sud de l’est, heure d’hiver singapour, Ouest de l’Australie, heure standard de Taipei, heure standard de Oulan-Bator, heure d’hiver Tokyo, heure standard de Corée, Yakoutsk heure d’hiver, CEN. Australie (heure standard), unités Analytics Centre (heure standard), E. Australie (heure standard), unités Analytics est (heure standard), Pacifique (ouest du Pacifique), heure standard Tasmanie, Magadan heure standard, heure standard Vladivostok, fuseau horaire russe 10, heure standard du Pacifique, fuseau horaire de la Russie, heure d’hiver Heure d’hiver îles de la ligne

ScaleAction

Paramètres de l’action de mise à l’échelle.

Name Type Description
cooldown
  • string

durée d’attente depuis la dernière action de mise à l’échelle avant que cette action se produise. Elle doit être comprise entre 1 semaine et 1 minute au format ISO 8601.

direction

le sens de mise à l’échelle. Indique si l’action de mise à l’échelle augmente ou diminue le nombre d’instances.

type

type d’action qui doit se produire lors du déclenchement de la règle de mise à l’échelle.

value
  • string

nombre d’instances impliquées dans l’action de mise à l’échelle. Cette valeur doit être définie sur 1 ou supérieur. La valeur par défaut est 1.

ScaleCapacity

Nombre d'instances qui peuvent être utilisées au cours de ce profil.

Name Type Description
default
  • string

nombre d’instances qui seront définies si les métriques ne sont pas disponibles pour l’évaluation. La valeur par défaut est utilisée uniquement si le nombre d'instances actives est inférieur à la valeur par défaut.

maximum
  • string

nombre maximal d’instances pour la ressource. Le nombre maximal d’instances réel est limité par les cœurs disponibles dans l’abonnement.

minimum
  • string

nombre minimal d’instances pour la ressource.

ScaleDirection

le sens de mise à l’échelle. Indique si l’action de mise à l’échelle augmente ou diminue le nombre d’instances.

Name Type Description
Decrease
  • string
Increase
  • string
None
  • string

ScaleRule

Règle qui fournit les déclencheurs et les paramètres de l’action de mise à l’échelle.

Name Type Description
metricTrigger

déclencheur qui produit une action de mise à l’échelle.

scaleAction

paramètres de l’action de mise à l’échelle.

ScaleRuleMetricDimension

Spécifie une dimension de métrique de règle de mise à l’échelle automatique.

Name Type Description
DimensionName
  • string

Nom de la dimension.

Operator

opérateur de dimension. Seuls’Equals’et’NotEquals’sont pris en charge. 'Equals’étant égal à l’une des valeurs. 'NotEquals’n’est pas égal à toutes les valeurs

Values
  • string[]

Liste des valeurs de dimension. Par exemple : ["app1", "App2"].

ScaleRuleMetricDimensionOperationType

opérateur de dimension. Seuls’Equals’et’NotEquals’sont pris en charge. 'Equals’étant égal à l’une des valeurs. 'NotEquals’n’est pas égal à toutes les valeurs

Name Type Description
Equals
  • string
NotEquals
  • string

ScaleType

type d’action qui doit se produire lors du déclenchement de la règle de mise à l’échelle.

Name Type Description
ChangeCount
  • string
ExactCount
  • string
PercentChangeCount
  • string
ServiceAllowedNextValue
  • string

TimeAggregationType

type d’agrégation de temps. Détermine la façon dont les données collectées doivent être combinées au fil du temps. La valeur par défaut est Average.

Name Type Description
Average
  • string
Count
  • string
Last
  • string
Maximum
  • string
Minimum
  • string
Total
  • string

TimeWindow

Date-heure spécifique pour le profil.

Name Type Description
end
  • string

heure de fin du profil au format ISO 8601.

start
  • string

heure de début du profil au format ISO 8601.

timeZone
  • string

fuseau horaire des heures de début et de fin du profil. Voici quelques exemples de fuseaux horaires valides : changement de date et heure standard, UTC-11, Hawaii, heure standard, heure standard du Pacifique (Mexique), heure standard du Pacifique, heure standard de la montagne, heure standard de la montagne (Mexique), heure standard de la montagne, heure d’hiver de l’Amérique centrale, heure standard centrale, heure du Centre des États-Unis, Canada, heure d’hiver du Pacifique, Est des États-Unis de l’est, heure d’hiver du Paraguay, heure d’hiver du Paraguay, heure d’hiver du Brésil Centre, heure d’hiver de l’ouest de l’Ouest, heure standard du Pacifique, heure d’hiver de l’Ouest, heure standard de l’Amérique du Sud, UTC-02, Mid-Atlantic de l’heure d’hiver, heure d’hiver des Açores, Heure standard du Cap-Vert, heure standard du Maroc, heure UTC, heure GMT, heure standard GMT, heure standard de Greenwich, heure d’hiver Europe centrale, heure standard de l’Europe de l’Ouest, heure standard de l’Europe centrale, heure standard de l’Afrique du Sud, heure standard de la côte de l’est, heure standard de l’Europe de l’est, Afrique du Sud, FLE, heure standard, Turquie, heure d’hiver, heure d’hiver Israël, heure standard de Libye, heure d’hiver arabe, heure d’hiver arabe, heure standard du Zone 3 Belarus, heure d’hiver de l’île de l’est, heure d’hiver de l’île de l’est, heure d’hiver du géorgien, heure d’hiver, heure d’hiver heure d’hiver Afghanistan, heure standard de l’asie de l’ouest, heure standard de iekaterinbourg, heure d’hiver Pakistan, inde, heure standard, Sri Lanka, heure standard du népal, heure standard de l’asie du nord, heure standard du SE Bangladesh, heure standard de l’asie du nord, heure du sud de l’est, heure d’hiver singapour, Ouest de l’Australie, heure standard de Taipei, heure standard de Oulan-Bator, heure d’hiver Tokyo, heure standard de Corée, Yakoutsk heure d’hiver, CEN. Australie (heure standard), unités Analytics Centre (heure standard), E. Australie (heure standard), unités Analytics est (heure standard), Pacifique (ouest du Pacifique), heure standard Tasmanie, Magadan heure standard, heure standard Vladivostok, fuseau horaire russe 10, heure standard du Pacifique, fuseau horaire de la Russie, heure d’hiver Heure d’hiver îles de la ligne

WebhookNotification

Notification webhook d’un événement de mise à l’échelle automatique.

Name Type Description
properties
  • object

jeu de propriétés de paramètres. Cette valeur peut être vide.

serviceUri
  • string

adresse de service pour recevoir la notification.