Diagnostic Settings - Create Or Update
Crea o actualiza la configuración de diagnóstico para el recurso especificado.
PUT https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings/{name}?api-version=2021-05-01-preview
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
name
|
path | True |
string |
Nombre de la configuración de diagnóstico. |
resource
|
path | True |
string |
Identificador del recurso. |
api-version
|
query | True |
string minLength: 1 |
Versión de la API que se va a usar para esta operación. |
Cuerpo de la solicitud
Nombre | Tipo | Description |
---|---|---|
properties.eventHubAuthorizationRuleId |
string |
Identificador de recurso para la regla de autorización del centro de eventos. |
properties.eventHubName |
string |
El nombre del centro de eventos. Si no se especifica ninguno, se seleccionará el centro de eventos predeterminado. |
properties.logAnalyticsDestinationType |
string |
Cadena que indica si la exportación a Log Analytics debe usar el tipo de destino predeterminado, es decir, AzureDiagnostics o usar un tipo de destino construido de la siguiente manera: _. Los valores posibles son: Dedicado y null (null es predeterminado). |
properties.logs |
Lista de la configuración de registros. |
|
properties.marketplacePartnerId |
string |
El identificador de recurso arm completo del recurso de Marketplace al que desea enviar registros de diagnóstico. |
properties.metrics |
Lista de la configuración de métricas. |
|
properties.serviceBusRuleId |
string |
Identificador de regla de Service Bus de la configuración de diagnóstico. Esto está aquí para mantener la compatibilidad con versiones anteriores. |
properties.storageAccountId |
string |
Identificador de recurso de la cuenta de almacenamiento a la que desea enviar registros de diagnóstico. |
properties.workspaceId |
string |
El identificador de recurso arm completo del área de trabajo de Log Analytics a la que desea enviar registros de diagnóstico. Ejemplo: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Solicitud correcta para crear una configuración de diagnóstico |
|
Other Status Codes |
Respuesta de error que describe por qué se produjo un error en la operación. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
user_impersonation | suplantar la cuenta de usuario |
Ejemplos
Creates or Updates the diagnostic setting |
Creates or Updates the diagnostic setting for category |
Creates or Updates the diagnostic setting
Solicitud de ejemplo
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"
}
}
Respuesta de muestra
{
"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
Solicitud de ejemplo
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"
}
}
Respuesta de muestra
{
"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"
}
}
Definiciones
Nombre | Description |
---|---|
created |
Tipo de identidad que creó el recurso. |
Diagnostic |
Recurso de configuración de diagnóstico. |
Error |
Describe el formato de respuesta de error. |
Log |
Parte de MultiTenantDiagnosticSettings. Especifica la configuración de un registro determinado. |
Metric |
Parte de MultiTenantDiagnosticSettings. Especifica la configuración de una métrica determinada. |
Retention |
Especifica la directiva de retención para el registro. |
system |
Metadatos relativos a la creación y última modificación del recurso. |
createdByType
Tipo de identidad que creó el recurso.
Valor | Description |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
DiagnosticSettingsResource
Recurso de configuración de diagnóstico.
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Nombre del recurso |
properties.eventHubAuthorizationRuleId |
string |
Identificador de recurso para la regla de autorización del centro de eventos. |
properties.eventHubName |
string |
El nombre del centro de eventos. Si no se especifica ninguno, se seleccionará el centro de eventos predeterminado. |
properties.logAnalyticsDestinationType |
string |
Cadena que indica si la exportación a Log Analytics debe usar el tipo de destino predeterminado, es decir, AzureDiagnostics o usar un tipo de destino construido de la siguiente manera: _. Los valores posibles son: Dedicado y null (null es predeterminado). |
properties.logs |
Lista de la configuración de registros. |
|
properties.marketplacePartnerId |
string |
El identificador de recurso arm completo del recurso de Marketplace al que desea enviar registros de diagnóstico. |
properties.metrics |
Lista de la configuración de métricas. |
|
properties.serviceBusRuleId |
string |
Identificador de regla de Service Bus de la configuración de diagnóstico. Esto está aquí para mantener la compatibilidad con versiones anteriores. |
properties.storageAccountId |
string |
Identificador de recurso de la cuenta de almacenamiento a la que desea enviar registros de diagnóstico. |
properties.workspaceId |
string |
El identificador de recurso arm completo del área de trabajo de Log Analytics a la que desea enviar registros de diagnóstico. Ejemplo: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 |
systemData |
Metadatos del sistema relacionados con este recurso. |
|
type |
string |
Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
ErrorResponse
Describe el formato de respuesta de error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error |
message |
string |
Mensaje de error que indica por qué se produjo un error en la operación. |
LogSettings
Parte de MultiTenantDiagnosticSettings. Especifica la configuración de un registro determinado.
Nombre | Tipo | Description |
---|---|---|
category |
string |
Nombre de una categoría registro de diagnóstico para un tipo de recurso al que se aplica esta configuración. Para obtener la lista de categorías de registro de diagnóstico de un recurso, realice primero una operación de configuración de diagnóstico GET. |
categoryGroup |
string |
Nombre de un grupo de categorías registro de diagnóstico para un tipo de recurso al que se aplica esta configuración. Para obtener la lista de categorías de registro de diagnóstico de un recurso, realice primero una operación de configuración de diagnóstico GET. |
enabled |
boolean |
valor que indica si este registro está habilitado. |
retentionPolicy |
la directiva de retención para este registro. |
MetricSettings
Parte de MultiTenantDiagnosticSettings. Especifica la configuración de una métrica determinada.
Nombre | Tipo | Description |
---|---|---|
category |
string |
Nombre de una categoría métrica de diagnóstico para un tipo de recurso al que se aplica esta configuración. Para obtener la lista de categorías de métricas de diagnóstico de un recurso, primero realice una operación get diagnostic settings (Configuración de diagnóstico GET). |
enabled |
boolean |
valor que indica si esta categoría está habilitada. |
retentionPolicy |
la directiva de retención para esta categoría. |
|
timeGrain |
string (duration) |
el período de tiempo de la métrica en formato ISO8601. |
RetentionPolicy
Especifica la directiva de retención para el registro.
Nombre | Tipo | Description |
---|---|---|
days |
integer (int32) minimum: 0 |
el número de días para la retención en días. Un valor de 0 conservará los eventos indefinidamente. |
enabled |
boolean |
valor que indica si la directiva de retención está habilitada. |
systemData
Metadatos relativos a la creación y última modificación del recurso.
Nombre | Tipo | Description |
---|---|---|
createdAt |
string (date-time) |
Marca de tiempo de creación de recursos (UTC). |
createdBy |
string |
Identidad que creó el recurso. |
createdByType |
Tipo de identidad que creó el recurso. |
|
lastModifiedAt |
string (date-time) |
Marca de tiempo de la última modificación del recurso (UTC) |
lastModifiedBy |
string |
Identidad que modificó por última vez el recurso. |
lastModifiedByType |
Tipo de identidad que modificó por última vez el recurso. |