Diagnostic Settings - Create Or Update
Cria ou atualiza as configurações de diagnóstico para o recurso especificado.
PUT https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings/{name}?api-version=2021-05-01-preview
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
name
|
path | True |
string |
O nome da configuração de diagnóstico. |
resource
|
path | True |
string |
O identificador do recurso. |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
Corpo da solicitação
Nome | Tipo | Description |
---|---|---|
properties.eventHubAuthorizationRuleId |
string |
A ID do recurso para a regra de autorização do hub de eventos. |
properties.eventHubName |
string |
O nome do hub de eventos. Se nenhum for especificado, o hub de eventos padrão será selecionado. |
properties.logAnalyticsDestinationType |
string |
Uma cadeia de caracteres que indica se a exportação para o Log Analytics deve usar o tipo de destino padrão, ou seja, AzureDiagnostics ou usar um tipo de destino construído da seguinte maneira: _. Os valores possíveis são: Dedicado e nulo (nulo é padrão.) |
properties.logs |
A lista de configurações de logs. |
|
properties.marketplacePartnerId |
string |
A ID de recurso arm completa do recurso do Marketplace para o qual você gostaria de enviar logs de diagnóstico. |
properties.metrics |
A lista de configurações de métrica. |
|
properties.serviceBusRuleId |
string |
A ID da regra do barramento de serviço da configuração de diagnóstico. Isso é aqui para manter a compatibilidade com versões anteriores. |
properties.storageAccountId |
string |
A ID do recurso da conta de armazenamento para a qual você gostaria de enviar logs de diagnóstico. |
properties.workspaceId |
string |
A ID completa do recurso ARM do workspace do Log Analytics para o qual você gostaria de enviar logs de diagnóstico. Exemplo: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Solicitação bem-sucedida para criar uma configuração de diagnóstico |
|
Other Status Codes |
Resposta de erro que descreve por que a operação falhou. |
Segurança
azure_auth
Fluxo do OAuth2 do Azure Active Directory
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
Nome | Description |
---|---|
user_impersonation | representar sua conta de usuário |
Exemplos
Creates or Updates the diagnostic setting |
Creates or Updates the diagnostic setting for category |
Creates or Updates the diagnostic setting
Solicitação de exemplo
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"
}
}
Resposta de exemplo
{
"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
Solicitação de exemplo
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"
}
}
Resposta de exemplo
{
"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"
}
}
Definições
Nome | Description |
---|---|
created |
O tipo de identidade que criou o recurso. |
Diagnostic |
O recurso de configuração de diagnóstico. |
Error |
Descreve o formato da resposta de erro. |
Log |
Parte de MultiTenantDiagnosticSettings. Especifica as configurações de um log específico. |
Metric |
Parte de MultiTenantDiagnosticSettings. Especifica as configurações de uma métrica específica. |
Retention |
Especifica a política de retenção para o log. |
system |
Metadados relativos à criação e à última modificação do recurso. |
createdByType
O tipo de identidade que criou o recurso.
Nome | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DiagnosticSettingsResource
O recurso de configuração de diagnóstico.
Nome | Tipo | Description |
---|---|---|
id |
string |
ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
O nome do recurso |
properties.eventHubAuthorizationRuleId |
string |
A ID do recurso para a regra de autorização do hub de eventos. |
properties.eventHubName |
string |
O nome do hub de eventos. Se nenhum for especificado, o hub de eventos padrão será selecionado. |
properties.logAnalyticsDestinationType |
string |
Uma cadeia de caracteres que indica se a exportação para o Log Analytics deve usar o tipo de destino padrão, ou seja, AzureDiagnostics ou usar um tipo de destino construído da seguinte maneira: _. Os valores possíveis são: Dedicado e nulo (nulo é padrão.) |
properties.logs |
A lista de configurações de logs. |
|
properties.marketplacePartnerId |
string |
A ID de recurso arm completa do recurso do Marketplace para o qual você gostaria de enviar logs de diagnóstico. |
properties.metrics |
A lista de configurações de métrica. |
|
properties.serviceBusRuleId |
string |
A ID da regra do barramento de serviço da configuração de diagnóstico. Isso é aqui para manter a compatibilidade com versões anteriores. |
properties.storageAccountId |
string |
A ID do recurso da conta de armazenamento para a qual você gostaria de enviar logs de diagnóstico. |
properties.workspaceId |
string |
A ID completa do recurso ARM do workspace do Log Analytics para o qual você gostaria de enviar logs de diagnóstico. Exemplo: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 |
systemData |
Os metadados do sistema relacionados a esse recurso. |
|
type |
string |
Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
ErrorResponse
Descreve o formato da resposta de erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Código do erro |
message |
string |
Mensagem de erro indicando por que a operação falhou. |
LogSettings
Parte de MultiTenantDiagnosticSettings. Especifica as configurações de um log específico.
Nome | Tipo | Description |
---|---|---|
category |
string |
Nome de uma categoria de Log de Diagnóstico para um tipo de recurso ao qual essa configuração é aplicada. Para obter a lista de categorias de Log de Diagnóstico para um recurso, primeiramente execute uma operação de configurações de diagnóstico GET. |
categoryGroup |
string |
Nome de um grupo de categorias do Log de Diagnóstico para um tipo de recurso ao qual essa configuração é aplicada. Para obter a lista de categorias de Log de Diagnóstico para um recurso, primeiramente execute uma operação de configurações de diagnóstico GET. |
enabled |
boolean |
um valor que indica se esse log está habilitado. |
retentionPolicy |
a política de retenção para esse log. |
MetricSettings
Parte de MultiTenantDiagnosticSettings. Especifica as configurações de uma métrica específica.
Nome | Tipo | Description |
---|---|---|
category |
string |
Nome de uma categoria de Métrica de Diagnóstico para um tipo de recurso ao qual essa configuração é aplicada. Para obter a lista de categorias de métrica de diagnóstico para um recurso, primeiro execute uma operação de configurações de diagnóstico GET. |
enabled |
boolean |
um valor que indica se essa categoria está habilitada. |
retentionPolicy |
a política de retenção para essa categoria. |
|
timeGrain |
string |
o timegrain da métrica no formato ISO8601. |
RetentionPolicy
Especifica a política de retenção para o log.
Nome | Tipo | Description |
---|---|---|
days |
integer |
o número de dias para a retenção em dias. Um valor 0 manterá os eventos indefinidamente. |
enabled |
boolean |
um valor que indica se a política de retenção está habilitada. |
systemData
Metadados relativos à criação e à última modificação do recurso.
Nome | Tipo | Description |
---|---|---|
createdAt |
string |
O carimbo de data/hora da criação de recursos (UTC). |
createdBy |
string |
A identidade que criou o recurso. |
createdByType |
O tipo de identidade que criou o recurso. |
|
lastModifiedAt |
string |
O carimbo de data/hora da última modificação do recurso (UTC) |
lastModifiedBy |
string |
A identidade que modificou o recurso pela última vez. |
lastModifiedByType |
O tipo de identidade que modificou o recurso pela última vez. |