openapi-directory/api/azure.com/applicationinsights-componentProactiveDetection_API.json

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

{"openapi":"3.0.0","info":{"description":"Azure Application Insights client for ProactiveDetection configurations of a component.","title":"ApplicationInsightsManagementClient","version":"2018-05-01-preview","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/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01/componentProactiveDetection_API.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"applicationinsights-componentProactiveDetection_API","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/ProactiveDetectionConfigs":{"get":{"description":"Gets a list of ProactiveDetection configurations of an Application Insights component.","operationId":"ProactiveDetectionConfigurations_List","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceNameParameter"}],"responses":{"200":{"description":"A list containing 0 or more ProactiveDetection configurations of an Application Insights component.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationInsightsComponentProactiveDetectionConfigurationListResult"},"examples":{"ProactiveDetectionConfigurationsList":{"$ref":"#/components/examples/ProactiveDetectionConfigurationsList"}}}}}}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/ProactiveDetectionConfigs/{ConfigurationId}":{"get":{"description":"Get the ProactiveDetection configuration for this configuration id.","operationId":"ProactiveDetectionConfigurations_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceNameParameter"},{"$ref":"#/components/parameters/ConfigurationId"}],"responses":{"200":{"description":"The ProactiveDetection configuration for this configuration id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationInsightsComponentProactiveDetectionConfiguration"},"examples":{"ProactiveDetectionConfigurationGet":{"$ref":"#/components/examples/ProactiveDetectionConfigurationGet"}}}}}}},"put":{"description":"Update the ProactiveDetection configuration for this configuration id.","operationId":"ProactiveDetectionConfigurations_Update","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceNameParameter"},{"$ref":"#/components/parameters/ConfigurationId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationInsightsComponentProactiveDetectionConfiguration"}}},"description":"Properties that need to be specified to update the ProactiveDetection configuration.","required":true},"responses":{"200":{"description":"The ProactiveDetection configuration that was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationInsightsComponentProactiveDetectionConfiguration"},"examples":{"ProactiveDetectionConfigurationUpdate":{"$ref":"#/components/examples/ProactiveDetectionConfigurationUpdate"}}}}}}}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"ProactiveDetectionConfigurationsList":{"value":[{"id":"/subscriptions/subid/resourceGroups/my-resource-group/providers/microsoft.insights/components/my-component/ProactiveDetectionConfigs/slowpageloadtime","location":"South Central US","name":"slowpageloadtime","properties":{"CustomEmails":["foo@microsoft.com","foo2@microsoft.com"],"Enabled":true,"Name":"slowpageloadtime","RuleDefinitions":{"Description":"Smart Detection rules notify you of performance anomaly issues.","DisplayName":"Slow page load time","HelpUrl":"https://docs.microsoft.com/en-us/azure/application-insights/app-insights-proactive-performance-diagnostics","IsEnabledByDefault":true,"IsHidden":false,"IsInPreview":false,"Name":"slowpageloadtime","SupportsEmailNotifications":true},"SendEmailsToSubscriptionOwners":true},"type":"Microsoft.Insights/components/ProactiveDetectionConfigs"},{"id":"/subscriptions/subid/resourceGroups/my-resource-group/providers/microsoft.insights/components/my-component/ProactiveDetectionConfigs/slowserverresponsetime","location":"South Central US","name":"slowserverresponsetime","properties":{"CustomEmails":[],"Enabled":true,"Name":"slowserverresponsetime","RuleDefinitions":{"Description":"Smart Detection rules notify you of performance anomaly issues.","DisplayName":"Slow server response time","HelpUrl":"https://docs.microsoft.com/en-us/azure/application-insights/app-insights-proactive-performance-diagnostics","IsEnabledByDefault":true,"IsHidden":false,"IsInPreview":false,"Name":"slowserverresponsetime","SupportsEmailNotifications":true},"SendEmailsToSubscriptionOwners":true},"type":"Microsoft.Insights/components/ProactiveDetectionConfigs"}]},"ProactiveDetectionConfigurationGet":{"value":{"id":"/subscriptions/subid/resourceGroups/my-resource-group/providers/microsoft.insights/components/my-component/ProactiveDetectionConfigs/slowpageloadtime","location":"South Central US","name":"slowpageloadtime","properties":{"CustomEmails":["foo@microsoft.com","foo2@microsoft.com"],"Enabled":true,"Name":"slowpageloadtime","RuleDefinitions":{"Description":"Smart Detection rules notify you of performance anomaly issues.","DisplayName":"Slow page load time","HelpUrl":"https://docs.microsoft.com/en-us/azure/application-insights/app-insights-proactive-performance-diagnostics","IsEnabledByDefault":true,"IsHidden":false,"IsInPreview":false,"Name":"slowpageloadtime","SupportsEmailNotifications":true},"SendEmailsToSubscriptionOwners":true},"type":"Microsoft.Insights/components/ProactiveDetectionConfigs"}},"ProactiveDetectionConfigurationUpdate":{"value":{"id":"/subscriptions/subid/resourceGroups/my-resource-group/providers/microsoft.insights/components/my-component/ProactiveDetectionConfigs/slowpageloadtime","location":"South Central US","name":"slowpageloadtime","properties":{"CustomEmails":["foo@microsoft.com","foo2@microsoft.com"],"Enabled":true,"Name":"slowpageloadtime","RuleDefinitions":{"Description":"Smart Detection rules notify you of performance anomaly issues.","DisplayName":"Slow page load time","HelpUrl":"https://docs.microsoft.com/en-us/azure/application-insights/app-insights-proactive-performance-diagnostics","IsEnabledByDefault":true,"IsHidden":false,"IsInPreview":false,"Name":"slowpageloadtime","SupportsEmailNotifications":true},"SendEmailsToSubscriptionOwners":true},"type":"Microsoft.Insights/components/ProactiveDetectionConfigs"}}},"parameters":{"ApiVersionParameter":{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ProactiveDetectionConfigurationsList":{"value":"2018-05-01-preview"},"ProactiveDetectionConfigurationGet":{"value":"2018-05-01-preview"},"ProactiveDetectionConfigurationUpdate":{"value":"2018-05-01-preview"}}},"ConfigurationId":{"description":"The ProactiveDetection configuration ID. This is unique within a Application Insights component.","in":"path","name":"ConfigurationId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ProactiveDetectionConfigurationGet":{"value":"slowpageloadtime"},"ProactiveDetectionConfigurationUpdate":{"value":"slowpageloadtime"}}},"ResourceGroupNameParameter":{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ProactiveDetectionConfigurationsList":{"value":"my-resource-group"},"ProactiveDetectionConfigurationGet":{"value":"my-resource-group"},"ProactiveDetectionConfigurationUpdate":{"value":"my-resource-group"}}},"ResourceNameParameter":{"description":"The name of the Application Insights component resource.","in":"path","name":"resourceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ProactiveDetectionConfigurationsList":{"value":"my-component"},"ProactiveDetectionConfigurationGet":{"value":"my-component"},"ProactiveDetectionConfigurationUpdate":{"value":"my-component"}}},"SubscriptionIdParameter":{"description":"The Azure subscription ID.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ProactiveDetectionConfigurationsList":{"value":"subid"},"ProactiveDetectionConfigurationGet":{"value":"subid"},"ProactiveDetectionConfigurationUpdate":{"value":"subid"}}}},"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":{"ApplicationInsightsComponentProactiveDetectionConfiguration":{"description":"A ProactiveDetection configuration definition.","properties":{"id":{"description":"Azure resource Id","readOnly":true,"type":"string"},"location":{"description":"Resource location","type":"string"},"name":{"description":"Azure resource name","type":"string"},"properties":{"$ref":"#/components/schemas/ApplicationInsightsComponentProactiveDetectionConfigurationProperties"},"type":{"description":"Azure resource type","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true},"ApplicationInsightsComponentProactiveDetectionConfigurationListResult":{"description":"A list of ProactiveDetection configurations.","items":{"$ref":"#/components/schemas/ApplicationInsightsComponentProactiveDetectionConfiguration"},"type":"array"},"ApplicationInsightsComponentProactiveDetectionConfigurationProperties":{"description":"Properties that define a ProactiveDetection configuration.","properties":{"CustomEmails":{"description":"Custom email addresses for this rule notifications","items":{"type":"string"},"readOnly":false,"type":"array"},"Enabled":{"description":"A flag that indicates whether this rule is enabled by the user","readOnly":false,"type":"boolean"},"LastUpdatedTime":{"description":"The last time this rule was updated","readOnly":true,"type":"string"},"Name":{"description":"The rule name","readOnly":true,"type":"string"},"RuleDefinitions":{"description":"Static definitions of the ProactiveDetection configuration rule (same values for all components).","properties":{"Description":{"description":"The rule description","readOnly":false,"type":"string"},"DisplayName":{"description":"The rule name as it is displayed in UI","readOnly":false,"type":"string"},"HelpUrl":{"description":"URL which displays additional info about the proactive detection rule","readOnly":false,"type":"string"},"IsEnabledByDefault":{"description":"A flag indicating whether the rule is enabled by default","readOnly":false,"type":"boolean"},"IsHidden":{"description":"A flag indicating whether the rule is hidden (from the UI)","readOnly":false,"type":"boolean"},"IsInPreview":{"description":"A flag indicating whether the rule is in preview","readOnly":false,"type":"boolean"},"Name":{"description":"The rule name","readOnly":false,"type":"string"},"SupportsEmailNotifications":{"description":"A flag indicating whether email notifications are supported for detections for this rule","readOnly":false,"type":"boolean"}},"readOnly":false,"type":"object"},"SendEmailsToSubscriptionOwners":{"description":"A flag that indicated whether notifications on this rule should be sent to subscription owners","readOnly":false,"type":"boolean"}},"type":"object"}}}}