Configurations - Create In Subscription

Référence

Service:: Advisor

Version d'API:: 2023-01-01

Créez/remplacez une configuration Azure Advisor et supprimez également toutes les configurations de groupes de ressources autonomes.

PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/configurations/default?api-version=2023-01-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
configurationName	path	True	ConfigurationName	Nom de la configuration d’Advisor. La valeur doit être « default »
subscriptionId	path	True	string	L’ID d’abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente.

Corps de la demande

Nom	Type	Description
properties.digests	DigestConfig[]	Configuration d’Advisor Digest. Valide uniquement pour les abonnements
properties.duration	Duration	Durée minimale pour l’évaluation de l’utilisation faible du processeur Advisor. Valide uniquement pour les abonnements. Valeurs valides : 7 (valeur par défaut), 14, 21, 30, 60 ou 90.
properties.exclude	boolean	Exclure la ressource des évaluations Advisor. Valeurs valides : False (valeur par défaut) ou True.
properties.lowCpuThreshold	CpuThreshold	Seuil de pourcentage minimal pour l’évaluation de l’utilisation faible du processeur Advisor. Valide uniquement pour les abonnements. Valeurs valides : 5 (valeur par défaut), 10, 15 ou 20.

Réponses

Nom	Type	Description
200 OK	ConfigData	Création/remplacement de la configuration.
Other Status Codes	ArmErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

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

PutConfigurations

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.Advisor/configurations/default?api-version=2023-01-01

{
  "properties": {
    "lowCpuThreshold": "5",
    "duration": "7",
    "exclude": true,
    "digests": [
      {
        "name": "digestConfigName",
        "actionGroupResourceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/microsoft.insights/actionGroups/actionGroupName",
        "frequency": 30,
        "categories": [
          "HighAvailability",
          "Security",
          "Performance",
          "Cost",
          "OperationalExcellence"
        ],
        "language": "en",
        "state": "Active"
      }
    ]
  }
}

Exemple de réponse

Code d’état:: 200

{
  "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Advisor/configurations/v2/default",
  "type": "Microsoft.Advisor/configurations",
  "name": "default",
  "properties": {
    "lowCpuThreshold": "5",
    "duration": "7",
    "exclude": true,
    "digests": [
      {
        "name": "digestConfigName",
        "actionGroupResourceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/microsoft.insights/actionGroups/actionGroupName",
        "frequency": 30,
        "categories": [
          "HighAvailability",
          "Security",
          "Performance",
          "Cost",
          "OperationalExcellence"
        ],
        "language": "en",
        "state": "Active"
      }
    ]
  }
}

Définitions

Nom	Description
ArmErrorResponse
ARMErrorResponseBody	Corps de réponse d’erreur ARM.
Category	Catégories pour laquelle envoyer le résumé. Si les catégories ne sont pas fournies, le résumé est envoyé pour toutes les catégories.
ConfigData	Structure des données de configuration Advisor.
ConfigurationName	Nom de la configuration d’Advisor. La valeur doit être « default »
CpuThreshold	Seuil de pourcentage minimal pour l’évaluation de l’utilisation faible du processeur Advisor. Valide uniquement pour les abonnements. Valeurs valides : 5 (valeur par défaut), 10, 15 ou 20.
createdByType	Type d’identité qui a créé la ressource.
DigestConfig	Entité de configuration Advisor Digest
DigestConfigState	État de la configuration de digest.
Duration	Durée minimale pour l’évaluation de l’utilisation faible du processeur Advisor. Valide uniquement pour les abonnements. Valeurs valides : 7 (valeur par défaut), 14, 21, 30, 60 ou 90.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

ArmErrorResponse

Nom	Type	Description
error	ARMErrorResponseBody	Corps de réponse d’erreur ARM.

ARMErrorResponseBody

Corps de réponse d’erreur ARM.

Nom	Type	Description
code	string	Obtient ou définit la chaîne qui peut être utilisée pour identifier l’erreur par programmation.
message	string	Obtient ou définit la chaîne qui décrit l’erreur en détail et fournit des informations de débogage.

Nom	Type	Description
Cost	string
HighAvailability	string
OperationalExcellence	string
Performance	string
Security	string

ConfigData

Structure des données de configuration Advisor.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	nom de la ressource.
properties.digests	DigestConfig[]	Configuration d’Advisor Digest. Valide uniquement pour les abonnements
properties.duration	Duration	Durée minimale pour l’évaluation de l’utilisation faible du processeur Advisor. Valide uniquement pour les abonnements. Valeurs valides : 7 (valeur par défaut), 14, 21, 30, 60 ou 90.
properties.exclude	boolean	Exclure la ressource des évaluations Advisor. Valeurs valides : False (valeur par défaut) ou True.
properties.lowCpuThreshold	CpuThreshold	Seuil de pourcentage minimal pour l’évaluation de l’utilisation faible du processeur Advisor. Valide uniquement pour les abonnements. Valeurs valides : 5 (valeur par défaut), 10, 15 ou 20.
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 »

ConfigurationName

Nom de la configuration d’Advisor. La valeur doit être « default »

Nom	Type	Description
default	string

CpuThreshold

Seuil de pourcentage minimal pour l’évaluation de l’utilisation faible du processeur Advisor. Valide uniquement pour les abonnements. Valeurs valides : 5 (valeur par défaut), 10, 15 ou 20.

Nom	Type	Description
10	string
15	string
20	string
5	string

createdByType

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

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DigestConfig

Entité de configuration Advisor Digest

Nom	Type	Description
actionGroupResourceId	string	ID de ressource du groupe d’actions utilisé par digest.
categories	Category[]	Catégories pour laquelle envoyer le résumé. Si les catégories ne sont pas fournies, le résumé est envoyé pour toutes les catégories.
frequency	integer	La fréquence de la digestion sera déclenchée, en jours. La valeur doit être comprise entre 7 et 30 jours inclus.
language	string	Langage pour le corps du contenu de synthèse. La valeur doit être du code ISO 639-1 pour l’un de Portail Azure langage pris en charge. Sinon, il sera converti en un seul. La valeur par défaut est Anglais (en).
name	string	Nom de la configuration digest. La valeur ne respecte pas la casse et doit être unique au sein d’un abonnement.
state	DigestConfigState	État de la configuration de digest.

DigestConfigState

État de la configuration de digest.

Nom	Type	Description
Active	string
Disabled	string

Duration

Durée minimale pour l’évaluation de l’utilisation faible du processeur Advisor. Valide uniquement pour les abonnements. Valeurs valides : 7 (valeur par défaut), 14, 21, 30, 60 ou 90.

Nom	Type	Description
14	string
21	string
30	string
60	string
7	string
90	string

systemData

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

Nom	Type	Description
createdAt	string	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	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la dernière ressource.
lastModifiedByType	createdByType	Type d’identité qui a modifié la dernière ressource.

Partager via