openapi-directory/api/azure.com/monitor-serviceDiagnosticsSettings_API.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"title":"MonitorManagementClient","version":"2016-09-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-09-01/serviceDiagnosticsSettings_API.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"monitor-serviceDiagnosticsSettings_API","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/{resourceUri}/providers/microsoft.insights/diagnosticSettings/service":{"get":{"description":"Gets the active diagnostic settings for the specified resource. **WARNING**: This method will be deprecated in future releases.","operationId":"ServiceDiagnosticSettings_Get","parameters":[{"$ref":"#/components/parameters/ResourceUriParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successful request to get more information about service diagnostic setting","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceDiagnosticSettingsResource"},"examples":{"response":{"value":{"id":"/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/diagnosticSettings/service","location":"","name":"service","properties":{"logs":[{"category":"WorkflowRuntime","enabled":true,"retentionPolicy":{"days":0,"enabled":false}}],"metrics":[{"enabled":true,"retentionPolicy":{"days":0,"enabled":false},"timeGrain":"PT1M"}],"serviceBusRuleId":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/andy1101/providers/Microsoft.EventHub/namespaces/andy1101/authorizationrules/RootManageSharedAccessKey","storageAccountId":"/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1","workspaceId":""},"tags":null,"type":""}},"Get service diagnostic setting":{"$ref":"#/components/examples/Get_service_diagnostic_setting"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["ServiceDiagnosticSettings"]},"patch":{"description":"Updates an existing ServiceDiagnosticSettingsResource. To update other fields use the CreateOrUpdate method. **WARNING**: This method will be deprecated in future releases.","operationId":"ServiceDiagnosticSettings_Update","parameters":[{"$ref":"#/components/parameters/ResourceUriParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceDiagnosticSettingsResourcePatch"}}},"description":"Parameters supplied to the operation.","required":true},"responses":{"200":{"description":"An existing service diagnostics setting resource was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceDiagnosticSettingsResource"},"examples":{"Update a service diagnostic setting":{"$ref":"#/components/examples/Update_a_service_diagnostic_setting"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"description":"Create or update new diagnostic settings for the specified resource. **WARNING**: This method will be deprecated in future releases.","operationId":"ServiceDiagnosticSettings_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/ResourceUriParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceDiagnosticSettingsResource"}}},"description":"Parameters supplied to the operation.","required":true},"responses":{"200":{"description":"Successful request to create a service diagnostic setting","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceDiagnosticSettingsResource"},"examples":{"response":{"value":{"id":"/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/diagnosticSettings/service","location":"","name":"service","properties":{"eventHubAuthorizationRuleId":"/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule","logs":[{"category":"WorkflowRuntime","enabled":true,"retentionPolicy":{"days":0,"enabled":false}}],"metrics":[{"enabled":true,"retentionPolicy":{"days":0,"enabled":false},"timeGrain":"PT1M"}],"serviceBusRuleId":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/andy1101/providers/Microsoft.EventHub/namespaces/andy1101/authorizationrules/RootManageSharedAccessKey","storageAccountId":"/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1","workspaceId":""},"tags":null,"type":""}},"Create or update a service diagnostic setting":{"$ref":"#/components/examples/Create_or_update_a_service_diagnostic_setting"}}}}}},"tags":["ServiceDiagnosticSettings"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Get_service_diagnostic_setting":{"value":{"id":"/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/diagnosticSettings/service","location":"","name":"service","properties":{"eventHubAuthorizationRuleId":"/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/eventhubs/myeventhub/authorizationrules/myrule","logs":[{"category":"WorkflowRuntime","enabled":true,"retentionPolicy":{"days":0,"enabled":false}}],"metrics":[{"enabled":true,"retentionPolicy":{"days":0,"enabled":false},"timeGrain":"PT1M"}],"serviceBusRuleId":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/andy1101/providers/Microsoft.EventHub/namespaces/andy1101/authorizationrules/RootManageSharedAccessKey","storageAccountId":"/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1","workspaceId":""},"type":""}},"Update_a_service_diagnostic_setting":{"value":{"id":"/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/diagnosticSettings/service","location":"","name":"service","properties":{"eventHubAuthorizationRuleId":"/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/eventhubs/myeventhub/authorizationrules/myrule","logs":[{"category":"WorkflowRuntime","enabled":true,"retentionPolicy":{"days":5,"enabled":false}}],"metrics":[{"enabled":true,"retentionPolicy":{"days":3,"enabled":false},"timeGrain":"PT1M"}],"serviceBusRuleId":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/andy1101/providers/Microsoft.EventHub/namespaces/andy1101/authorizationrules/RootManageSharedAccessKey","storageAccountId":"/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1","workspaceId":""},"type":""}},"Create_or_update_a_service_diagnostic_setting":{"value":{"id":"/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/diagnosticSettings/service","location":"","name":"service","properties":{"eventHubAuthorizationRuleId":"/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/eventhubs/myeventhub/authorizationrules/myrule","logs":[{"category":"WorkflowRuntime","enabled":true,"retentionPolicy":{"days":0,"enabled":false}}],"metrics":[{"enabled":true,"retentionPolicy":{"days":0,"enabled":false},"timeGrain":"PT1M"}],"serviceBusRuleId":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/andy1101/providers/Microsoft.EventHub/namespaces/andy1101/authorizationrules/RootManageSharedAccessKey","storageAccountId":"/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1","workspaceId":""},"type":""}}},"parameters":{"ApiVersionParameter":{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get service diagnostic setting":{"value":"2016-09-01"},"Update a service diagnostic setting":{"value":"2016-09-01"},"Create or update a service diagnostic setting":{"value":"2016-09-01"}}},"ResourceUriParameter":{"description":"The identifier of the resource.","in":"path","name":"resourceUri","required":true,"x-ms-parameter-location":"method","x-ms-skip-url-encoding":true,"schema":{"type":"string"},"examples":{"Get service diagnostic setting":{"value":"/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6"},"Update a service diagnostic setting":{"value":"/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6"},"Create or update a service diagnostic setting":{"value":"/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"ErrorResponse":{"description":"Describes the format of Error response.","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"},"LogSettings":{"description":"Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular log.","properties":{"category":{"description":"Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation.","type":"string"},"enabled":{"description":"a value indicating whether this log is enabled.","type":"boolean"},"retentionPolicy":{"$ref":"#/components/schemas/RetentionPolicy"}},"required":["enabled"]},"MetricSettings":{"description":"Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular metric.","properties":{"enabled":{"description":"a value indicating whether this timegrain is enabled.","type":"boolean"},"retentionPolicy":{"$ref":"#/components/schemas/RetentionPolicy"},"timeGrain":{"description":"the timegrain of the metric in ISO8601 format.","format":"duration","type":"string"}},"required":["enabled","timeGrain"]},"Resource":{"description":"An azure resource object","properties":{"id":{"description":"Azure resource Id","readOnly":true,"type":"string"},"location":{"description":"Resource location","type":"string","x-ms-mutability":["create","read"]},"name":{"description":"Azure resource name","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags"},"type":{"description":"Azure resource type","readOnly":true,"type":"string"}},"required":["location"],"x-ms-azure-resource":true},"RetentionPolicy":{"description":"Specifies the retention policy for the log.","properties":{"days":{"description":"the number of days for the retention in days. A value of 0 will retain the events indefinitely.","format":"int32","minimum":0,"type":"integer"},"enabled":{"description":"a value indicating whether the retention policy is enabled.","type":"boolean"}},"required":["enabled","days"]},"ServiceDiagnosticSettings":{"description":"The diagnostic settings for service.","properties":{"eventHubAuthorizationRuleId":{"description":"The resource Id for the event hub namespace authorization rule.","type":"string"},"logs":{"description":"the list of logs settings.","items":{"$ref":"#/components/schemas/LogSettings"},"type":"array"},"metrics":{"description":"the list of metric settings.","items":{"$ref":"#/components/schemas/MetricSettings"},"type":"array"},"serviceBusRuleId":{"description":"The service bus rule ID of the service bus namespace in which you would like to have Event Hubs created for streaming Diagnostic Logs. The rule ID is of the format: '{service bus resource ID}/authorizationrules/{key name}'.","type":"string"},"storageAccountId":{"description":"The resource ID of the storage account to which you would like to send Diagnostic Logs.","type":"string"},"workspaceId":{"description":"The workspace ID (resource ID of a Log Analytics workspace) for a Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2","type":"string"}}},"ServiceDiagnosticSettingsResource":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"Description of a service diagnostic setting","properties":{"properties":{"$ref":"#/components/schemas/ServiceDiagnosticSettings"}},"type":"object"},"ServiceDiagnosticSettingsResourcePatch":{"description":"Service diagnostic setting resource for patch operations","properties":{"properties":{"$ref":"#/components/schemas/ServiceDiagnosticSettings"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags"}}}}}}