Partager via


Diagnostic Settings - Create Or Update

Crée ou met à jour les paramètres de diagnostic pour la ressource spécifiée.

PUT https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings/{name}?api-version=2021-05-01-preview

Paramètres URI

Nom Dans Obligatoire Type Description
name
path True

string

Nom du paramètre de diagnostic.

resourceUri
path True

string

Identificateur de la ressource.

api-version
query True

string

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

Corps de la demande

Nom Type Description
properties.eventHubAuthorizationRuleId

string

ID de ressource pour la règle d’autorisation du hub d’événements.

properties.eventHubName

string

Nom du hub d’événements. Si aucun n’est spécifié, le hub d’événements par défaut est sélectionné.

properties.logAnalyticsDestinationType

string

Chaîne indiquant si l’exportation vers Log Analytics doit utiliser le type de destination par défaut, c’est-à-dire AzureDiagnostics, ou utiliser un type de destination construit comme suit : _. Les valeurs possibles sont : Dedicated et Null (null est la valeur par défaut.)

properties.logs

LogSettings[]

Liste des paramètres des journaux.

properties.marketplacePartnerId

string

ID de ressource ARM complet de la ressource de la Place de marché à laquelle vous souhaitez envoyer les journaux de diagnostic.

properties.metrics

MetricSettings[]

Liste des paramètres de métrique.

properties.serviceBusRuleId

string

ID de règle Service Bus du paramètre de diagnostic. Ceci est là pour maintenir la compatibilité descendante.

properties.storageAccountId

string

ID de ressource du compte de stockage auquel vous souhaitez envoyer les journaux de diagnostic.

properties.workspaceId

string

ID de ressource ARM complet de l’espace de travail Log Analytics auquel vous souhaitez envoyer les journaux de diagnostic. Exemple : /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

Réponses

Nom Type Description
200 OK

DiagnosticSettingsResource

Demande de création d’un paramètre de diagnostic réussie

Other Status Codes

ErrorResponse

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

Creates or Updates the diagnostic setting
Creates or Updates the diagnostic setting for category

Creates or Updates the diagnostic setting

Exemple de requête

PUT https://management.azure.com/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/Microsoft.Insights/diagnosticSettings/mysetting?api-version=2021-05-01-preview

{
  "properties": {
    "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
    "workspaceId": "",
    "eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
    "eventHubName": "myeventhub",
    "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
    "metrics": [
      {
        "category": "WorkflowMetrics",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logs": [
      {
        "categoryGroup": "allLogs",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logAnalyticsDestinationType": "Dedicated"
  }
}

Exemple de réponse

{
  "id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/microsoft.insights/diagnosticSettings/mysetting",
  "type": "Microsoft.Insights/diagnosticSettings",
  "name": "mysetting",
  "properties": {
    "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
    "workspaceId": "",
    "eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
    "eventHubName": "myeventhub",
    "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
    "metrics": [
      {
        "category": "WorkflowMetrics",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logs": [
      {
        "categoryGroup": "allLogs",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logAnalyticsDestinationType": "Dedicated"
  }
}

Creates or Updates the diagnostic setting for category

Exemple de requête

PUT https://management.azure.com/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/Microsoft.Insights/diagnosticSettings/mysetting?api-version=2021-05-01-preview

{
  "properties": {
    "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
    "workspaceId": "",
    "eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
    "eventHubName": "myeventhub",
    "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
    "metrics": [
      {
        "category": "WorkflowMetrics",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logs": [
      {
        "category": "WorkflowRuntime",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logAnalyticsDestinationType": "Dedicated"
  }
}

Exemple de réponse

{
  "id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/diagnosticSettings/mysetting",
  "type": "",
  "name": "mysetting",
  "properties": {
    "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
    "workspaceId": "",
    "eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
    "eventHubName": "myeventhub",
    "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
    "metrics": [
      {
        "category": "WorkflowMetrics",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logs": [
      {
        "category": "WorkflowRuntime",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logAnalyticsDestinationType": "Dedicated"
  }
}

Définitions

Nom Description
createdByType

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

DiagnosticSettingsResource

Ressource de paramètre de diagnostic.

ErrorResponse

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

LogSettings

Partie de MultiTenantDiagnosticSettings. Spécifie les paramètres d’un journal particulier.

MetricSettings

Partie de MultiTenantDiagnosticSettings. Spécifie les paramètres d’une métrique particulière.

RetentionPolicy

Spécifie la stratégie de rétention pour le journal.

systemData

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

createdByType

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

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

DiagnosticSettingsResource

Ressource de paramètre de diagnostic.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

nom de la ressource.

properties.eventHubAuthorizationRuleId

string

ID de ressource pour la règle d’autorisation du hub d’événements.

properties.eventHubName

string

Nom du hub d’événements. Si aucun n’est spécifié, le hub d’événements par défaut est sélectionné.

properties.logAnalyticsDestinationType

string

Chaîne indiquant si l’exportation vers Log Analytics doit utiliser le type de destination par défaut, c’est-à-dire AzureDiagnostics, ou utiliser un type de destination construit comme suit : _. Les valeurs possibles sont : Dedicated et Null (null est la valeur par défaut.)

properties.logs

LogSettings[]

Liste des paramètres des journaux.

properties.marketplacePartnerId

string

ID de ressource ARM complet de la ressource de la Place de marché à laquelle vous souhaitez envoyer les journaux de diagnostic.

properties.metrics

MetricSettings[]

Liste des paramètres de métrique.

properties.serviceBusRuleId

string

ID de règle Service Bus du paramètre de diagnostic. Ceci est là pour maintenir la compatibilité descendante.

properties.storageAccountId

string

ID de ressource du compte de stockage auquel vous souhaitez envoyer les journaux de diagnostic.

properties.workspaceId

string

ID de ressource ARM complet de l’espace de travail Log Analytics auquel vous souhaitez envoyer les journaux de diagnostic. Exemple : /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

systemData

systemData

Métadonnées système liées à cette ressource.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ErrorResponse

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

Nom Type Description
code

string

Code d'erreur

message

string

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

LogSettings

Partie de MultiTenantDiagnosticSettings. Spécifie les paramètres d’un journal particulier.

Nom Type Description
category

string

Nom d’une catégorie de journal de diagnostic pour un type de ressource auquel ce paramètre est appliqué. Pour obtenir la liste des catégories de journal de diagnostic pour une ressource, commencez par effectuer une opération d’obtention (GET) des paramètres de diagnostic.

categoryGroup

string

Nom d’un groupe de catégories de journal de diagnostic pour un type de ressource auquel ce paramètre est appliqué. Pour obtenir la liste des catégories de journal de diagnostic pour une ressource, commencez par effectuer une opération d’obtention (GET) des paramètres de diagnostic.

enabled

boolean

valeur indiquant si ce journal est activé.

retentionPolicy

RetentionPolicy

stratégie de rétention pour ce journal.

MetricSettings

Partie de MultiTenantDiagnosticSettings. Spécifie les paramètres d’une métrique particulière.

Nom Type Description
category

string

Nom d’une catégorie de métrique de diagnostic pour un type de ressource auquel ce paramètre est appliqué. Pour obtenir la liste des catégories de métriques de diagnostic pour une ressource, commencez par effectuer une opération GET des paramètres de diagnostic.

enabled

boolean

valeur indiquant si cette catégorie est activée.

retentionPolicy

RetentionPolicy

stratégie de rétention pour cette catégorie.

timeGrain

string

timegrain de la métrique dans ISO8601 format.

RetentionPolicy

Spécifie la stratégie de rétention pour le journal.

Nom Type Description
days

integer

nombre de jours pour la rétention en jours. La valeur 0 conservera les événements indéfiniment.

enabled

boolean

valeur indiquant si la stratégie de rétention est activée.

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 ressource pour la dernière fois.

lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.