{ "swagger": "2.0", "info": { "title": "Azure Log Analytics Network Security Perimeter APIs", "version": "2025-07-01", "description": "Provides NSP operations for working with Log Analytics.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "Operations" }, { "name": "Clusters" }, { "name": "DataExport" }, { "name": "Workspaces" }, { "name": "AvailableServiceTiers" }, { "name": "IntelligencePacks" }, { "name": "DataSources" }, { "name": "LinkedServices" }, { "name": "LinkedStorageAccounts" }, { "name": "SavedSearches" }, { "name": "StorageInsights" }, { "name": "Tables" }, { "name": "NetworkSecurityPerimeterConfigurations" }, { "name": "SummaryRules" }, { "name": "asyncOperations" }, { "name": "DeletedWorkspaces" } ], "paths": { "/providers/Microsoft.OperationalInsights/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "description": "Lists all of the available OperationalInsights Rest API operations.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get specific operation status": { "$ref": "./examples/OperationsListByTenant.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/clusters": { "get": { "operationId": "Clusters_List", "tags": [ "Clusters" ], "description": "Gets the Log Analytics clusters in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ClusterListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ClustersSubscriptionList": { "$ref": "./examples/ClustersSubscriptionList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/deletedWorkspaces": { "get": { "operationId": "DeletedWorkspaces_List", "tags": [ "DeletedWorkspaces" ], "description": "Gets recently deleted workspaces in a subscription, available for recovery.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/WorkspaceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WorkspacesSubscriptionList": { "$ref": "./examples/WorkspacesSubscriptionList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/locations/{location}/operationStatuses/{asyncOperationId}": { "get": { "operationId": "OperationStatuses_Get", "tags": [ "asyncOperations" ], "description": "Get the status of a long running azure asynchronous operation.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" }, { "name": "asyncOperationId", "in": "path", "description": "The operation Id.", "required": true, "type": "string" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OperationStatus" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get specific operation status": { "$ref": "./examples/OperationStatusesGet.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/queryPacks": { "get": { "operationId": "QueryPacks_List", "description": "Gets a list of all Log Analytics QueryPacks within a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LogAnalyticsQueryPackListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueryPacksList": { "$ref": "./examples/QueryPacksList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/workspaces": { "get": { "operationId": "Workspaces_List", "tags": [ "Workspaces" ], "description": "Gets the workspaces in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WorkspaceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WorkspacesSubscriptionList": { "$ref": "./examples/WorkspacesSubscriptionListForWorkSpace.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters": { "get": { "operationId": "Clusters_ListByResourceGroup", "tags": [ "Clusters" ], "description": "Gets Log Analytics clusters in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ClusterListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ClustersGet": { "$ref": "./examples/ClustersListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}": { "get": { "operationId": "Clusters_Get", "tags": [ "Clusters" ], "description": "Gets a Log Analytics cluster instance.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "Name of the Log Analytics Cluster.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Cluster" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ClustersGet": { "$ref": "./examples/ClustersGet.json" } } }, "put": { "operationId": "Clusters_CreateOrUpdate", "tags": [ "Clusters" ], "description": "Create or update a Log Analytics cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "Name of the Log Analytics Cluster.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters required to create or update a Log Analytics cluster.", "required": true, "schema": { "$ref": "#/definitions/Cluster" } } ], "responses": { "200": { "description": "Resource 'Cluster' update operation succeeded", "schema": { "$ref": "#/definitions/Cluster" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ClustersCreate": { "$ref": "./examples/ClustersCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Cluster" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Clusters_Update", "tags": [ "Clusters" ], "description": "Updates a Log Analytics cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "Name of the Log Analytics Cluster.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters required to patch a Log Analytics cluster.", "required": true, "schema": { "$ref": "#/definitions/ClusterPatch" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Cluster" } }, "202": { "description": "Resource update request accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ClustersPatch": { "$ref": "./examples/ClustersUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Cluster" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Clusters_Delete", "tags": [ "Clusters" ], "description": "Deletes a cluster instance.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "Name of the Log Analytics Cluster.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ClustersDelete": { "$ref": "./examples/ClustersDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/deletedWorkspaces": { "get": { "operationId": "DeletedWorkspaces_ListByResourceGroup", "tags": [ "DeletedWorkspaces" ], "description": "Gets recently deleted workspaces in a resource group, available for recovery.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/WorkspaceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WorkspacesGet": { "$ref": "./examples/WorkspacesListByResourceGroupForDeleted.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/locations/{location}/workspaces/{workspaceName}/failover": { "post": { "operationId": "Workspaces_Failover", "tags": [ "Workspaces" ], "description": "Activates failover for the specified workspace.\n\nThe specified replication location must match the location of the enabled replication for this workspace. The failover operation is asynchronous and can take up to 30 minutes to complete. The status of the operation can be checked using the operationId returned in the response.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WorkspacesFailover": { "$ref": "./examples/WorkspacesFailover.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks": { "get": { "operationId": "QueryPacks_ListByResourceGroup", "description": "Gets a list of Log Analytics QueryPacks within a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LogAnalyticsQueryPackListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueryPackListByResourceGroup": { "$ref": "./examples/QueryPacksListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } }, "put": { "operationId": "QueryPacks_CreateOrUpdateWithoutName", "description": "Creates a Log Analytics QueryPack. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "LogAnalyticsQueryPackPayload", "in": "body", "description": "The request body", "required": true, "schema": { "$ref": "#/definitions/LogAnalyticsQueryPack" } } ], "responses": { "201": { "description": "Resource 'LogAnalyticsQueryPack' create operation succeeded", "schema": { "$ref": "#/definitions/LogAnalyticsQueryPack" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueryPackCreateNoName": { "$ref": "./examples/QueryPacksCreateNoName.json" }, "QueryPackUpdateNoName": { "$ref": "./examples/QueryPackUpdateNoName.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName}": { "get": { "operationId": "QueryPacks_Get", "description": "Returns a Log Analytics QueryPack.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "queryPackName", "in": "path", "description": "The name of the Log Analytics QueryPack resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LogAnalyticsQueryPack" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueryPackGet": { "$ref": "./examples/QueryPacksGet.json" } } }, "put": { "operationId": "QueryPacks_CreateOrUpdate", "description": "Creates (or updates) a Log Analytics QueryPack. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "queryPackName", "in": "path", "description": "The name of the Log Analytics QueryPack resource.", "required": true, "type": "string" }, { "name": "LogAnalyticsQueryPackPayload", "in": "body", "description": "Properties that need to be specified to create or update a Log Analytics QueryPack.", "required": true, "schema": { "$ref": "#/definitions/LogAnalyticsQueryPack" } } ], "responses": { "200": { "description": "Resource 'LogAnalyticsQueryPack' update operation succeeded", "schema": { "$ref": "#/definitions/LogAnalyticsQueryPack" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueryPackCreate": { "$ref": "./examples/QueryPacksCreate.json" }, "QueryPackUpdate": { "$ref": "./examples/QueryPacksUpdate.json" } } }, "patch": { "operationId": "QueryPacks_UpdateTags", "description": "Updates an existing QueryPack's tags. To update other fields use the CreateOrUpdate method.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "queryPackName", "in": "path", "description": "The name of the Log Analytics QueryPack resource.", "required": true, "type": "string" }, { "name": "QueryPackTags", "in": "body", "description": "Updated tag information to set into the QueryPack instance.", "required": true, "schema": { "$ref": "#/definitions/TagsResource" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LogAnalyticsQueryPack" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueryPackUpdateTagsOnly": { "$ref": "./examples/QueryPacksUpdateTagsOnly.json" } } }, "delete": { "operationId": "QueryPacks_Delete", "description": "Deletes a Log Analytics QueryPack.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "queryPackName", "in": "path", "description": "The name of the Log Analytics QueryPack resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueryPacksDelete": { "$ref": "./examples/QueryPacksDelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName}/queries": { "get": { "operationId": "Queries_List", "description": "Gets a list of Queries defined within a Log Analytics QueryPack.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "queryPackName", "in": "path", "description": "The name of the Log Analytics QueryPack resource.", "required": true, "type": "string" }, { "name": "$top", "in": "query", "description": "Maximum items returned in page.", "required": false, "type": "integer", "format": "int64" }, { "name": "includeBody", "in": "query", "description": "Flag indicating whether or not to return the body of each applicable query. If false, only return the query information.", "required": false, "type": "boolean" }, { "name": "$skipToken", "in": "query", "description": "Base64 encoded token used to fetch the next page of items. Default is null.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LogAnalyticsQueryPackQueryListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueryList": { "$ref": "./examples/QueryPackQueriesList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName}/queries/{id}": { "get": { "operationId": "Queries_Get", "description": "Gets a specific Log Analytics Query defined within a Log Analytics QueryPack.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "queryPackName", "in": "path", "description": "The name of the Log Analytics QueryPack resource.", "required": true, "type": "string" }, { "name": "id", "in": "path", "description": "The id of a specific query defined in the Log Analytics QueryPack", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LogAnalyticsQueryPackQuery" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueryGet": { "$ref": "./examples/QueryPackQueriesGet.json" } } }, "put": { "operationId": "Queries_Put", "description": "Adds or Updates a specific Query within a Log Analytics QueryPack.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "queryPackName", "in": "path", "description": "The name of the Log Analytics QueryPack resource.", "required": true, "type": "string" }, { "name": "id", "in": "path", "description": "The id of a specific query defined in the Log Analytics QueryPack", "required": true, "type": "string" }, { "name": "QueryPayload", "in": "body", "description": "Properties that need to be specified to create a new query and add it to a Log Analytics QueryPack.", "required": true, "schema": { "$ref": "#/definitions/LogAnalyticsQueryPackQuery" } } ], "responses": { "200": { "description": "Resource 'LogAnalyticsQueryPackQuery' update operation succeeded", "schema": { "$ref": "#/definitions/LogAnalyticsQueryPackQuery" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueryPut": { "$ref": "./examples/QueryPackQueriesPut.json" } } }, "patch": { "operationId": "Queries_Update", "description": "Adds or Updates a specific Query within a Log Analytics QueryPack.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "queryPackName", "in": "path", "description": "The name of the Log Analytics QueryPack resource.", "required": true, "type": "string" }, { "name": "id", "in": "path", "description": "The id of a specific query defined in the Log Analytics QueryPack", "required": true, "type": "string" }, { "name": "QueryPayload", "in": "body", "description": "Properties that need to be specified to create a new query and add it to a Log Analytics QueryPack.", "required": true, "schema": { "$ref": "#/definitions/LogAnalyticsQueryPackQuery" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LogAnalyticsQueryPackQuery" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueryPatch": { "$ref": "./examples/QueryPackQueriesUpdate.json" } } }, "delete": { "operationId": "Queries_Delete", "description": "Deletes a specific Query defined within an Log Analytics QueryPack.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "queryPackName", "in": "path", "description": "The name of the Log Analytics QueryPack resource.", "required": true, "type": "string" }, { "name": "id", "in": "path", "description": "The id of a specific query defined in the Log Analytics QueryPack", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueryDelete": { "$ref": "./examples/QueryPackQueriesDelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName}/queries/search": { "post": { "operationId": "Queries_Search", "description": "Search a list of Queries defined within a Log Analytics QueryPack according to given search properties.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "queryPackName", "in": "path", "description": "The name of the Log Analytics QueryPack resource.", "required": true, "type": "string" }, { "name": "$top", "in": "query", "description": "Maximum items returned in page.", "required": false, "type": "integer", "format": "int64" }, { "name": "includeBody", "in": "query", "description": "Flag indicating whether or not to return the body of each applicable query. If false, only return the query information.", "required": false, "type": "boolean" }, { "name": "$skipToken", "in": "query", "description": "Base64 encoded token used to fetch the next page of items. Default is null.", "required": false, "type": "string" }, { "name": "QuerySearchProperties", "in": "body", "description": "Properties by which to search queries in the given Log Analytics QueryPack.", "required": true, "schema": { "$ref": "#/definitions/LogAnalyticsQueryPackQuerySearchProperties" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LogAnalyticsQueryPackQueryListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QuerySearch": { "$ref": "./examples/QueryPackQueriesSearch.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces": { "get": { "operationId": "Workspaces_ListByResourceGroup", "tags": [ "Workspaces" ], "description": "Gets workspaces in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WorkspaceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WorkspacesGet": { "$ref": "./examples/WorkspacesListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}": { "get": { "operationId": "Workspaces_Get", "tags": [ "Workspaces" ], "description": "Gets a workspace instance.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Workspace" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WorkspaceGet": { "$ref": "./examples/WorkspacesGet.json" } } }, "put": { "operationId": "Workspaces_CreateOrUpdate", "tags": [ "Workspaces" ], "description": "Create or update a workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "parameters", "in": "body", "description": "The parameters required to create or update a workspace.", "required": true, "schema": { "$ref": "#/definitions/Workspace" } } ], "responses": { "200": { "description": "Resource 'Workspace' update operation succeeded", "schema": { "$ref": "#/definitions/Workspace" } }, "201": { "description": "Resource 'Workspace' create operation succeeded", "schema": { "$ref": "#/definitions/Workspace" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WorkspacesCreate": { "$ref": "./examples/WorkspacesCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Workspace" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Workspaces_Update", "tags": [ "Workspaces" ], "description": "Updates a workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "parameters", "in": "body", "description": "The parameters required to patch a workspace.", "required": true, "schema": { "$ref": "#/definitions/WorkspacePatch" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Workspace" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WorkspacesPatch": { "$ref": "./examples/WorkspacesUpdate.json" } } }, "delete": { "operationId": "Workspaces_Delete", "tags": [ "Workspaces" ], "description": "Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "force", "in": "query", "description": "Deletes the workspace without the recovery option. A workspace that was deleted with this flag cannot be recovered.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WorkspacesDelete": { "$ref": "./examples/WorkspacesDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/availableServiceTiers": { "get": { "operationId": "AvailableServiceTiers_ListByWorkspace", "tags": [ "AvailableServiceTiers" ], "description": "Gets the available service tiers for the workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "array", "items": { "$ref": "#/definitions/AvailableServiceTier" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AvailableServiceTiers": { "$ref": "./examples/WorkspacesAvailableServiceTiers.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataExports": { "get": { "operationId": "DataExports_ListByWorkspace", "tags": [ "DataExport" ], "description": "Lists the data export instances within a workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataExportListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DataExportGet": { "$ref": "./examples/DataExportListByWorkspace.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataExports/{dataExportName}": { "get": { "operationId": "DataExports_Get", "tags": [ "DataExport" ], "description": "Gets a data export instance.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "dataExportName", "in": "path", "description": "The data export rule name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataExport" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DataExportGet": { "$ref": "./examples/DataExportGet.json" } } }, "put": { "operationId": "DataExports_CreateOrUpdate", "tags": [ "DataExport" ], "description": "Create or update a data export.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "dataExportName", "in": "path", "description": "The data export rule name.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters required to create or update a data export.", "required": true, "schema": { "$ref": "#/definitions/DataExport" } } ], "responses": { "200": { "description": "Resource 'DataExport' update operation succeeded", "schema": { "$ref": "#/definitions/DataExport" } }, "201": { "description": "Resource 'DataExport' create operation succeeded", "schema": { "$ref": "#/definitions/DataExport" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DataExportCreate": { "$ref": "./examples/DataExportCreateOrUpdate.json" } } }, "delete": { "operationId": "DataExports_Delete", "tags": [ "DataExport" ], "description": "Deletes the specified data export in a given workspace..", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "dataExportName", "in": "path", "description": "The data export rule name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "404": { "description": "ignore" }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DataExportDelete": { "$ref": "./examples/DataExportDelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataSources": { "get": { "operationId": "DataSources_ListByWorkspace", "tags": [ "DataSources" ], "description": "Gets the first page of data source instances in a workspace with the link to the next page.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation.", "required": true, "type": "string" }, { "name": "$skiptoken", "in": "query", "description": "Starting point of the collection of data source instances.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataSourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DataSourcesListByWorkspace": { "$ref": "./examples/DataSourcesListByWorkspace.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataSources/{dataSourceName}": { "get": { "operationId": "DataSources_Get", "tags": [ "DataSources" ], "description": "Gets a datasource instance.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "dataSourceName", "in": "path", "description": "Name of the datasource", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataSource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DataSourcesGet": { "$ref": "./examples/DataSourcesGet.json" } } }, "put": { "operationId": "DataSources_CreateOrUpdate", "tags": [ "DataSources" ], "description": "Create or update a data source.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "dataSourceName", "in": "path", "description": "Name of the datasource", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters required to create or update a datasource.", "required": true, "schema": { "$ref": "#/definitions/DataSource" } } ], "responses": { "200": { "description": "Resource 'DataSource' update operation succeeded", "schema": { "$ref": "#/definitions/DataSource" } }, "201": { "description": "Resource 'DataSource' create operation succeeded", "schema": { "$ref": "#/definitions/DataSource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DataSourcesCreate": { "$ref": "./examples/DataSourcesCreate.json" } } }, "delete": { "operationId": "DataSources_Delete", "tags": [ "DataSources" ], "description": "Deletes a data source instance.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "dataSourceName", "in": "path", "description": "Name of the datasource", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DataSourcesDelete": { "$ref": "./examples/DataSourcesDelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/failback": { "post": { "operationId": "Workspaces_Failback", "tags": [ "Workspaces" ], "description": "Deactivates failover for the specified workspace.\n\nThe failback operation is asynchronous and can take up to 30 minutes to complete. The status of the operation can be checked using the operationId returned in the response.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WorkspacesFailover": { "$ref": "./examples/WorkspacesFailback.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/gateways/{gatewayId}": { "delete": { "operationId": "Gateways_Delete", "tags": [ "Workspaces" ], "description": "Delete a Log Analytics gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "gatewayId", "in": "path", "description": "The Log Analytics gateway Id.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DeleteGateways": { "$ref": "./examples/WorkspacesGatewaysDelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/intelligencePacks": { "get": { "operationId": "IntelligencePacks_List", "tags": [ "Workspaces", "IntelligencePacks" ], "description": "Lists all the intelligence packs possible and whether they are enabled or disabled for a given workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "array", "items": { "$ref": "#/definitions/IntelligencePack" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "IntelligencePacksList": { "$ref": "./examples/WorkspacesListIntelligencePacks.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/intelligencePacks/{intelligencePackName}/Disable": { "post": { "operationId": "IntelligencePacks_Disable", "tags": [ "Workspaces", "IntelligencePacks" ], "description": "Disables an intelligence pack for a given workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "intelligencePackName", "in": "path", "description": "The name of the intelligence pack.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "IntelligencePacksDisable": { "$ref": "./examples/WorkspacesDisableIntelligencePack.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/intelligencePacks/{intelligencePackName}/Enable": { "post": { "operationId": "IntelligencePacks_Enable", "tags": [ "Workspaces", "IntelligencePacks" ], "description": "Enables an intelligence pack for a given workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "intelligencePackName", "in": "path", "description": "The name of the intelligence pack.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "IntelligencePacksEnable": { "$ref": "./examples/WorkspacesEnableIntelligencePack.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedServices": { "get": { "operationId": "LinkedServices_ListByWorkspace", "tags": [ "LinkedServices" ], "description": "Gets the linked services instances in a workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LinkedServiceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "LinkedServicesListByWorkspace": { "$ref": "./examples/LinkedServicesListByWorkspace.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedServices/{linkedServiceName}": { "get": { "operationId": "LinkedServices_Get", "tags": [ "LinkedServices" ], "description": "Gets a linked service instance.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "linkedServiceName", "in": "path", "description": "Name of the linked service.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LinkedService" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "LinkedServicesGet": { "$ref": "./examples/LinkedServicesGet.json" } } }, "put": { "operationId": "LinkedServices_CreateOrUpdate", "tags": [ "LinkedServices" ], "description": "Create or update a linked service.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "linkedServiceName", "in": "path", "description": "Name of the linked service.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters required to create or update a linked service.", "required": true, "schema": { "$ref": "#/definitions/LinkedService" } } ], "responses": { "200": { "description": "Resource 'LinkedService' update operation succeeded", "schema": { "$ref": "#/definitions/LinkedService" } }, "201": { "description": "Resource 'LinkedService' create operation succeeded", "schema": { "$ref": "#/definitions/LinkedService" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "LinkedServicesCreate": { "$ref": "./examples/LinkedServicesCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/LinkedService" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "LinkedServices_Delete", "tags": [ "LinkedServices" ], "description": "Deletes a linked service instance.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "linkedServiceName", "in": "path", "description": "Name of the linked service.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LinkedService" } }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "LinkedServicesDelete": { "$ref": "./examples/LinkedServicesDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/LinkedService" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedStorageAccounts": { "get": { "operationId": "LinkedStorageAccounts_ListByWorkspace", "tags": [ "LinkedStorageAccounts" ], "description": "Gets all linked storage accounts associated with the specified workspace, storage accounts will be sorted by their data source type.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LinkedStorageAccountsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets list of linked storage accounts on a workspace.": { "$ref": "./examples/LinkedStorageAccountsListByWorkspace.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedStorageAccounts/{dataSourceType}": { "get": { "operationId": "LinkedStorageAccounts_Get", "tags": [ "LinkedStorageAccounts" ], "description": "Gets all linked storage account of a specific data source type associated with the specified workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "dataSourceType", "in": "path", "description": "Linked storage accounts type.", "required": true, "type": "string", "enum": [ "CustomLogs", "AzureWatson", "Query", "Ingestion", "Alerts" ], "x-ms-enum": { "name": "DataSourceType", "modelAsString": false, "values": [ { "name": "CustomLogs", "value": "CustomLogs", "description": "CustomLogs" }, { "name": "AzureWatson", "value": "AzureWatson", "description": "AzureWatson" }, { "name": "Query", "value": "Query", "description": "Query" }, { "name": "Ingestion", "value": "Ingestion", "description": "Ingestion" }, { "name": "Alerts", "value": "Alerts", "description": "Alerts" } ] } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LinkedStorageAccountsResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "LinkedStorageAccountsGet": { "$ref": "./examples/LinkedStorageAccountsGet.json" } } }, "put": { "operationId": "LinkedStorageAccounts_CreateOrUpdate", "tags": [ "LinkedStorageAccounts" ], "description": "Create or Update a link relation between current workspace and a group of storage accounts of a specific data source type.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "dataSourceType", "in": "path", "description": "Linked storage accounts type.", "required": true, "type": "string", "enum": [ "CustomLogs", "AzureWatson", "Query", "Ingestion", "Alerts" ], "x-ms-enum": { "name": "DataSourceType", "modelAsString": false, "values": [ { "name": "CustomLogs", "value": "CustomLogs", "description": "CustomLogs" }, { "name": "AzureWatson", "value": "AzureWatson", "description": "AzureWatson" }, { "name": "Query", "value": "Query", "description": "Query" }, { "name": "Ingestion", "value": "Ingestion", "description": "Ingestion" }, { "name": "Alerts", "value": "Alerts", "description": "Alerts" } ] } }, { "name": "parameters", "in": "body", "description": "The parameters required to create or update linked storage accounts.", "required": true, "schema": { "$ref": "#/definitions/LinkedStorageAccountsResource" } } ], "responses": { "200": { "description": "Resource 'LinkedStorageAccountsResource' update operation succeeded", "schema": { "$ref": "#/definitions/LinkedStorageAccountsResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "LinkedStorageAccountsCreate": { "$ref": "./examples/LinkedStorageAccountsCreate.json" } } }, "delete": { "operationId": "LinkedStorageAccounts_Delete", "tags": [ "LinkedStorageAccounts" ], "description": "Deletes all linked storage accounts of a specific data source type associated with the specified workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "dataSourceType", "in": "path", "description": "Linked storage accounts type.", "required": true, "type": "string", "enum": [ "CustomLogs", "AzureWatson", "Query", "Ingestion", "Alerts" ], "x-ms-enum": { "name": "DataSourceType", "modelAsString": false, "values": [ { "name": "CustomLogs", "value": "CustomLogs", "description": "CustomLogs" }, { "name": "AzureWatson", "value": "AzureWatson", "description": "AzureWatson" }, { "name": "Query", "value": "Query", "description": "Query" }, { "name": "Ingestion", "value": "Ingestion", "description": "Ingestion" }, { "name": "Alerts", "value": "Alerts", "description": "Alerts" } ] } } ], "responses": { "200": { "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "LinkedStorageAccountsDelete": { "$ref": "./examples/LinkedStorageAccountsDelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/managementGroups": { "get": { "operationId": "ManagementGroups_List", "tags": [ "Workspaces" ], "description": "Gets a list of management groups connected to a workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WorkspaceListManagementGroupsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WorkspacesListManagementGroups": { "$ref": "./examples/WorkspacesListManagementGroups.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/networkSecurityPerimeterConfigurations": { "get": { "operationId": "Workspaces_ListNSP", "tags": [ "NetworkSecurityPerimeterConfigurations" ], "description": "Gets a list of NSP configurations for specified workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/networksecurityperimeter.json#/definitions/NetworkSecurityPerimeterConfigurationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List NSP configs by Scheduled Query Rule": { "$ref": "./examples/NSPForWorkspaces_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}": { "get": { "operationId": "Workspaces_GetNSP", "tags": [ "NetworkSecurityPerimeterConfigurations" ], "description": "Gets a network security perimeter configuration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "networkSecurityPerimeterConfigurationName", "in": "path", "description": "The name for a network security perimeter configuration", "required": true, "type": "string", "minLength": 1, "maxLength": 512, "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/networksecurityperimeter.json#/definitions/NetworkSecurityPerimeterConfiguration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get NSP config by name for Scheduled Query Rule": { "$ref": "./examples/NSPForWorkspaces_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}/reconcile": { "post": { "operationId": "Workspaces_ReconcileNSP", "tags": [ "NetworkSecurityPerimeterConfigurations" ], "description": "Reconcile network security perimeter configuration for Workspace resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "networkSecurityPerimeterConfigurationName", "in": "path", "description": "The name for a network security perimeter configuration", "required": true, "type": "string", "minLength": 1, "maxLength": 512, "pattern": "^.*$" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Reconcile NSP config for Scheduled Query Rule": { "$ref": "./examples/NSPForWorkspaces_Reconcile.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/operations/{purgeId}": { "get": { "operationId": "WorkspacePurge_GetPurgeStatus", "tags": [ "Workspaces" ], "description": "Gets status of an ongoing purge operation.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "purgeId", "in": "path", "description": "In a purge status request, this is the Id of the operation the status of which is returned.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WorkspacePurgeStatusResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WorkspacePurgeOperation": { "$ref": "./examples/WorkspacesPurgeOperation.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/purge": { "post": { "operationId": "WorkspacePurge_Purge", "tags": [ "Workspaces" ], "description": "Purges data in an Log Analytics workspace by a set of user-defined filters.\n\nIn order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected.\nLog Analytics only supports purge operations required for compliance with GDPR. The Log Analytics product team reserves the right to reject requests for purge operations that are not for the purpose of GDPR compliance. In the event of a dispute, please create a support ticket", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "body", "in": "body", "description": "Describes the body of a request to purge data in a single table of an Log Analytics Workspace", "required": true, "schema": { "$ref": "#/definitions/WorkspacePurgeBody" } } ], "responses": { "202": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WorkspacePurgeResponse" }, "headers": { "x-ms-status-location": { "type": "string", "description": "The location from which to request the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WorkspacePurge": { "$ref": "./examples/WorkspacesPurge.json" }, "WorkspacePurgeResourceId": { "$ref": "./examples/WorkspacesPurgeResourceId.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/regenerateSharedKey": { "post": { "operationId": "SharedKeys_Regenerate", "tags": [ "Workspaces" ], "description": "Regenerates the shared keys for a Log Analytics Workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SharedKeys" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RegenerateSharedKeys": { "$ref": "./examples/WorkspacesRegenerateSharedKeys.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/savedSearches": { "get": { "operationId": "SavedSearches_ListByWorkspace", "tags": [ "SavedSearches" ], "description": "Gets the saved searches for a given Log Analytics Workspace", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SavedSearchesListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavedSearchesList": { "$ref": "./examples/SavedSearchesListByWorkspace.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/savedSearches/{savedSearchId}": { "get": { "operationId": "SavedSearches_Get", "tags": [ "SavedSearches" ], "description": "Gets the specified saved search for a given workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "savedSearchId", "in": "path", "description": "The id of the saved search.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SavedSearch" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavedSearchesGet": { "$ref": "./examples/WorkspacesSavedSearchesGet.json" } } }, "put": { "operationId": "SavedSearches_CreateOrUpdate", "tags": [ "SavedSearches" ], "description": "Creates or updates a saved search for a given workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "savedSearchId", "in": "path", "description": "The id of the saved search.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters required to save a search.", "required": true, "schema": { "$ref": "#/definitions/SavedSearch" } } ], "responses": { "200": { "description": "Resource 'SavedSearch' update operation succeeded", "schema": { "$ref": "#/definitions/SavedSearch" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavedSearchCreateOrUpdate": { "$ref": "./examples/WorkspacesSavedSearchesCreateOrUpdate.json" } } }, "delete": { "operationId": "SavedSearches_Delete", "tags": [ "SavedSearches" ], "description": "Deletes the specified saved search in a given workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "savedSearchId", "in": "path", "description": "The id of the saved search.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavedSearchesDelete": { "$ref": "./examples/WorkspacesDeleteSavedSearches.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/schema": { "post": { "operationId": "Schema_Get", "tags": [ "Workspaces" ], "description": "Gets the schema for a given workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SearchGetSchemaResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WorkspacesGetSchema": { "$ref": "./examples/SavedSearchesGetSchema.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/sharedKeys": { "post": { "operationId": "SharedKeys_GetSharedKeys", "tags": [ "Workspaces" ], "description": "Gets the shared keys for a workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SharedKeys" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SharedKeysList": { "$ref": "./examples/WorkspacesGetSharedKeys.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/storageInsightConfigs": { "get": { "operationId": "StorageInsightConfigs_ListByWorkspace", "tags": [ "StorageInsights" ], "description": "Lists the storage insight instances within a workspace", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/StorageInsightListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "StorageInsightsList": { "$ref": "./examples/StorageInsightsListByWorkspace.json" } }, "x-ms-pageable": { "nextLinkName": "@odata.nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/storageInsightConfigs/{storageInsightName}": { "get": { "operationId": "StorageInsightConfigs_Get", "tags": [ "StorageInsights" ], "description": "Gets a storage insight instance.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "storageInsightName", "in": "path", "description": "Name of the storageInsightsConfigs resource", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/StorageInsight" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "StorageInsightsGet": { "$ref": "./examples/StorageInsightsGet.json" } } }, "put": { "operationId": "StorageInsightConfigs_CreateOrUpdate", "tags": [ "StorageInsights" ], "description": "Create or update a storage insight.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "storageInsightName", "in": "path", "description": "Name of the storageInsightsConfigs resource", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters required to create or update a storage insight.", "required": true, "schema": { "$ref": "#/definitions/StorageInsight" } } ], "responses": { "200": { "description": "Resource 'StorageInsight' update operation succeeded", "schema": { "$ref": "#/definitions/StorageInsight" } }, "201": { "description": "Resource 'StorageInsight' create operation succeeded", "schema": { "$ref": "#/definitions/StorageInsight" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "StorageInsightsCreate": { "$ref": "./examples/StorageInsightsCreateOrUpdate.json" } } }, "delete": { "operationId": "StorageInsightConfigs_Delete", "tags": [ "StorageInsights" ], "description": "Deletes a storageInsightsConfigs resource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "storageInsightName", "in": "path", "description": "Name of the storageInsightsConfigs resource", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "StorageInsightsDelete": { "$ref": "./examples/StorageInsightsDelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/summaryLogs": { "get": { "operationId": "SummaryLogs_ListByWorkspace", "tags": [ "SummaryRules" ], "description": "Gets all summary rules for the specified Log Analytics workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SummaryLogsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SummaryLogsListByWorkspace": { "$ref": "./examples/SummaryLogsList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/summaryLogs/{summaryLogsName}": { "get": { "operationId": "SummaryLogs_Get", "tags": [ "SummaryRules" ], "description": "Gets Log Analytics workspace Summary rules.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "summaryLogsName", "in": "path", "description": "The name of the summary logs. Must not contain '/'.", "required": true, "type": "string", "pattern": "[^/]+" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SummaryLogs" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SummaryLogsGet": { "$ref": "./examples/SummaryLogsGet.json" } } }, "put": { "operationId": "SummaryLogs_CreateOrUpdate", "tags": [ "SummaryRules" ], "description": "Creates or updates Log Analytics workspace Summary rules.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "summaryLogsName", "in": "path", "description": "The name of the summary logs. Must not contain '/'.", "required": true, "type": "string", "pattern": "[^/]+" }, { "name": "parameters", "in": "body", "description": "The parameters required to update summary rules properties.", "required": true, "schema": { "$ref": "#/definitions/SummaryLogs" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/SummaryLogs" }, "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "201": { "description": "Resource 'SummaryLogs' create operation succeeded", "schema": { "$ref": "#/definitions/SummaryLogs" }, "headers": { "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SummaryLogsUpsert": { "$ref": "./examples/SummaryLogsUpsert.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/SummaryLogs" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "SummaryLogs_Delete", "tags": [ "SummaryRules" ], "description": "Deletes Log Analytics workspace Summary rules.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "summaryLogsName", "in": "path", "description": "The name of the summary logs. Must not contain '/'.", "required": true, "type": "string", "pattern": "[^/]+" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SummaryLogsDelete": { "$ref": "./examples/SummaryLogsDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/summaryLogs/{summaryLogsName}/retrybin": { "post": { "operationId": "SummaryLogs_RetryBin", "tags": [ "SummaryRules" ], "description": "Retries a failed Summary rule bin.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "summaryLogsName", "in": "path", "description": "The name of the summary logs. Must not contain '/'.", "required": true, "type": "string", "pattern": "[^/]+" }, { "name": "parameters", "in": "body", "description": "The parameters required to retry a Summary rule bin.", "required": true, "schema": { "$ref": "#/definitions/SummaryLogsRetryBin" } } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SummaryLogsRetryBin": { "$ref": "./examples/SummaryLogsRetryBin.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/summaryLogs/{summaryLogsName}/start": { "post": { "operationId": "SummaryLogs_Start", "tags": [ "SummaryRules" ], "description": "Starts an inactive Summary rule.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "summaryLogsName", "in": "path", "description": "The name of the summary logs. Must not contain '/'.", "required": true, "type": "string", "pattern": "[^/]+" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SummaryLogsStart": { "$ref": "./examples/SummaryLogsStart.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/summaryLogs/{summaryLogsName}/stop": { "post": { "operationId": "SummaryLogs_Stop", "tags": [ "SummaryRules" ], "description": "Stops an active Summary rule.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "summaryLogsName", "in": "path", "description": "The name of the summary logs. Must not contain '/'.", "required": true, "type": "string", "pattern": "[^/]+" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SummaryLogsStop": { "$ref": "./examples/SummaryLogsStop.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables": { "get": { "operationId": "Tables_ListByWorkspace", "tags": [ "Tables" ], "description": "Gets all the tables for the specified Log Analytics workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TablesListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TablesListByWorkspace": { "$ref": "./examples/TablesList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}": { "get": { "operationId": "Tables_Get", "tags": [ "Tables" ], "description": "Gets a Log Analytics workspace table.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "tableName", "in": "path", "description": "The name of the table.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9-_]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Table" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TablesGet": { "$ref": "./examples/TablesGet.json" } } }, "put": { "operationId": "Tables_CreateOrUpdate", "tags": [ "Tables" ], "description": "Update or Create a Log Analytics workspace table.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "tableName", "in": "path", "description": "The name of the table.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9-_]+$" }, { "name": "parameters", "in": "body", "description": "The parameters required to update table properties.", "required": true, "schema": { "$ref": "#/definitions/Table" } } ], "responses": { "200": { "description": "Resource 'Table' update operation succeeded", "schema": { "$ref": "#/definitions/Table" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TablesUpsert": { "$ref": "./examples/TablesUpsertForTable.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Table" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Tables_Update", "tags": [ "Tables" ], "description": "Update a Log Analytics workspace table.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "tableName", "in": "path", "description": "The name of the table.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9-_]+$" }, { "name": "parameters", "in": "body", "description": "The parameters required to update table properties.", "required": true, "schema": { "$ref": "#/definitions/Table" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Table" } }, "202": { "description": "Resource update request accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TablesUpsert": { "$ref": "./examples/TablesUpsert.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Table" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Tables_Delete", "tags": [ "Tables" ], "description": "Delete a Log Analytics workspace table.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "tableName", "in": "path", "description": "The name of the table.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9-_]+$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TablesDelete": { "$ref": "./examples/TablesDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}/cancelSearch": { "post": { "operationId": "Tables_CancelSearch", "tags": [ "Tables" ], "description": "Cancel a log analytics workspace search results table query run.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "tableName", "in": "path", "description": "The name of the table.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9-_]+$" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TablesSearchCancel": { "$ref": "./examples/TablesSearchCancel.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}/migrate": { "post": { "operationId": "Tables_Migrate", "tags": [ "Tables" ], "description": "Migrate a Log Analytics table from support of the Data Collector API and Custom Fields features to support of Data Collection Rule-based Custom Logs.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, { "name": "tableName", "in": "path", "description": "The name of the table.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9-_]+$" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TablesMigrate": { "$ref": "./examples/TablesMigrate.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/usages": { "get": { "operationId": "Usages_List", "tags": [ "Workspaces" ], "description": "Gets a list of usage metrics for a workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 4, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WorkspaceListUsagesResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "UsagesList": { "$ref": "./examples/WorkspacesListUsages.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "AssociatedWorkspace": { "type": "object", "description": "The list of Log Analytics workspaces associated with the cluster.", "properties": { "workspaceId": { "type": "string", "format": "uuid", "description": "Associated workspace immutable id.", "readOnly": true }, "workspaceName": { "type": "string", "description": "Associated workspace resource name.", "readOnly": true }, "resourceId": { "type": "string", "format": "arm-id", "description": "Associated workspace arm resource id, in the form of: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.OperationalInsights/workspaces" } ] } }, "associateDate": { "type": "string", "format": "date-time", "description": "The time of workspace association.", "readOnly": true } } }, "AvailableServiceTier": { "type": "object", "description": "Service Tier details.", "properties": { "serviceTier": { "$ref": "#/definitions/SkuNameEnum", "description": "The name of the Service Tier.", "readOnly": true }, "enabled": { "type": "boolean", "description": "True if the Service Tier is enabled for the workspace.", "readOnly": true }, "minimumRetention": { "type": "integer", "format": "int64", "description": "The minimum retention for the Service Tier, in days.", "readOnly": true }, "maximumRetention": { "type": "integer", "format": "int64", "description": "The maximum retention for the Service Tier, in days.", "readOnly": true }, "defaultRetention": { "type": "integer", "format": "int64", "description": "The default retention for the Service Tier, in days.", "readOnly": true }, "capacityReservationLevel": { "type": "integer", "format": "int64", "description": "The capacity reservation level in GB per day. Returned for the Capacity Reservation Service Tier.", "readOnly": true }, "lastSkuUpdate": { "type": "string", "description": "Time when the sku was last updated for the workspace. Returned for the Capacity Reservation Service Tier.", "readOnly": true } } }, "AzureEntityResource": { "type": "object", "title": "Entity Resource", "description": "The resource model definition for an Azure Resource Manager resource with an etag.", "properties": { "etag": { "type": "string", "description": "Resource Etag.", "readOnly": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ] }, "BillingType": { "type": "string", "description": "Configures whether billing will be only on the cluster or each workspace will be billed by its proportional use. This does not change the overall billing, only how it will be distributed. Default value is 'Cluster'", "enum": [ "Cluster", "Workspaces" ], "x-ms-enum": { "name": "BillingType", "modelAsString": true, "values": [ { "name": "Cluster", "value": "Cluster", "description": "Cluster" }, { "name": "Workspaces", "value": "Workspaces", "description": "Workspaces" } ] } }, "CapacityReservationProperties": { "type": "object", "description": "The Capacity Reservation properties.", "properties": { "lastSkuUpdate": { "type": "string", "format": "date-time", "description": "The last time Sku was updated.", "readOnly": true }, "minCapacity": { "type": "integer", "format": "int64", "description": "Minimum CapacityReservation value in Gigabytes.", "readOnly": true } } }, "Cluster": { "type": "object", "description": "The top level Log Analytics cluster resource container.", "properties": { "properties": { "$ref": "#/definitions/ClusterProperties", "description": "Log Analytics cluster properties.", "x-ms-client-flatten": true }, "identity": { "$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "The managed service identities assigned to this resource." }, "sku": { "$ref": "#/definitions/ClusterSku", "description": "The sku properties." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "ClusterEntityStatus": { "type": "string", "description": "The provisioning state of the cluster.", "enum": [ "Creating", "Succeeded", "Failed", "Canceled", "Deleting", "ProvisioningAccount", "Updating" ], "x-ms-enum": { "name": "ClusterEntityStatus", "modelAsString": true, "values": [ { "name": "Creating", "value": "Creating", "description": "Creating" }, { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Canceled", "value": "Canceled", "description": "Canceled" }, { "name": "Deleting", "value": "Deleting", "description": "Deleting" }, { "name": "ProvisioningAccount", "value": "ProvisioningAccount", "description": "ProvisioningAccount" }, { "name": "Updating", "value": "Updating", "description": "Updating" } ] } }, "ClusterListResult": { "type": "object", "description": "The response of a Cluster list operation.", "properties": { "value": { "type": "array", "description": "The Cluster items on this page", "items": { "$ref": "#/definitions/Cluster" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ClusterPatch": { "type": "object", "description": "The top level Log Analytics cluster resource container.", "properties": { "properties": { "$ref": "#/definitions/ClusterPatchProperties", "description": "Log Analytics cluster properties.", "x-ms-client-flatten": true }, "identity": { "$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "Resource's identity." }, "sku": { "$ref": "#/definitions/ClusterSku", "description": "The sku properties." }, "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" }, "x-ms-mutability": [ "read", "update", "create" ] } } }, "ClusterPatchProperties": { "type": "object", "description": "Log Analytics cluster patch properties.", "properties": { "keyVaultProperties": { "$ref": "#/definitions/keyVaultProperties", "description": "The associated key properties." }, "billingType": { "$ref": "#/definitions/BillingType", "description": "The cluster's billing type." } } }, "ClusterProperties": { "type": "object", "description": "Cluster properties.", "properties": { "clusterId": { "type": "string", "description": "The ID associated with the cluster.", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ClusterEntityStatus", "description": "The provisioning state of the cluster.", "readOnly": true }, "isDoubleEncryptionEnabled": { "type": "boolean", "description": "Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is 'true'", "x-ms-mutability": [ "read", "create" ] }, "isAvailabilityZonesEnabled": { "type": "boolean", "description": "Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones." }, "billingType": { "$ref": "#/definitions/BillingType", "description": "The cluster's billing type." }, "keyVaultProperties": { "$ref": "#/definitions/keyVaultProperties", "description": "The associated key properties." }, "lastModifiedDate": { "type": "string", "format": "date-time", "description": "The last time the cluster was updated.", "readOnly": true }, "createdDate": { "type": "string", "format": "date-time", "description": "The cluster creation time", "readOnly": true }, "associatedWorkspaces": { "type": "array", "description": "The list of Log Analytics workspaces associated with the cluster", "items": { "$ref": "#/definitions/AssociatedWorkspace" }, "x-ms-identifiers": [ "workspaceId" ] }, "capacityReservationProperties": { "$ref": "#/definitions/CapacityReservationProperties", "description": "Additional properties for capacity reservation" }, "replication": { "$ref": "#/definitions/ClusterReplicationProperties", "description": "Cluster's replication properties." } } }, "ClusterReplicationProperties": { "type": "object", "description": "Cluster replication properties.", "properties": { "location": { "type": "string", "description": "The secondary location of the replication. If replication is being enabled, enabled must be provided.", "x-ms-mutability": [ "read", "create" ] }, "enabled": { "type": "boolean", "description": "Specifies whether the replication is enabled or not. When true the cluster is replicate to the specified location." }, "isAvailabilityZonesEnabled": { "type": "boolean", "description": "Should enable AvailabilityZones for the given replicated cluster" }, "provisioningState": { "$ref": "#/definitions/ClusterReplicationState", "description": "The provisioning state of the cluster replication.", "readOnly": true }, "createdDate": { "type": "string", "format": "date-time", "description": "The cluster's replication creation time", "readOnly": true }, "lastModifiedDate": { "type": "string", "format": "date-time", "description": "The last time the cluster's replication was updated.", "readOnly": true } } }, "ClusterReplicationState": { "type": "string", "description": "The provisioning state of the cluster replication.", "enum": [ "Succeeded", "EnableRequested", "Enabling", "DisableRequested", "Disabling", "RollbackRequested", "RollingBack", "Failed", "Canceled" ], "x-ms-enum": { "name": "ClusterReplicationState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "EnableRequested", "value": "EnableRequested", "description": "EnableRequested" }, { "name": "Enabling", "value": "Enabling", "description": "Enabling" }, { "name": "DisableRequested", "value": "DisableRequested", "description": "DisableRequested" }, { "name": "Disabling", "value": "Disabling", "description": "Disabling" }, { "name": "RollbackRequested", "value": "RollbackRequested", "description": "RollbackRequested" }, { "name": "RollingBack", "value": "RollingBack", "description": "RollingBack" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Canceled", "value": "Canceled", "description": "Canceled" } ] } }, "ClusterSku": { "type": "object", "description": "The cluster sku definition.", "properties": { "capacity": { "type": "integer", "format": "int64", "description": "The capacity reservation level in Gigabytes for this cluster.", "x-nullable": true }, "name": { "$ref": "#/definitions/ClusterSkuNameEnum", "description": "The SKU (tier) of a cluster." } } }, "ClusterSkuNameEnum": { "type": "string", "description": "The SKU (tier) of a cluster.", "enum": [ "CapacityReservation" ], "x-ms-enum": { "name": "ClusterSkuNameEnum", "modelAsString": true, "values": [ { "name": "CapacityReservation", "value": "CapacityReservation", "description": "CapacityReservation" } ] } }, "Column": { "type": "object", "description": "Table column.", "properties": { "name": { "type": "string", "description": "Column name." }, "type": { "$ref": "#/definitions/ColumnTypeEnum", "description": "Column data type." }, "dataTypeHint": { "$ref": "#/definitions/ColumnDataTypeHintEnum", "description": "Column data type logical hint." }, "displayName": { "type": "string", "description": "Column display name. Can be set at creation time; after creation, updates must either match column name or set to null/empty. If not provided, defaults to column name." }, "description": { "type": "string", "description": "Column description." }, "isDefaultDisplay": { "type": "boolean", "description": "Is displayed by default.", "readOnly": true }, "isHidden": { "type": "boolean", "description": "Is column hidden.", "readOnly": true } } }, "ColumnDataTypeHintEnum": { "type": "string", "description": "Column data type logical hint.", "enum": [ "uri", "guid", "armPath", "ip" ], "x-ms-enum": { "name": "ColumnDataTypeHintEnum", "modelAsString": true, "values": [ { "name": "uri", "value": "uri", "description": "A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment" }, { "name": "guid", "value": "guid", "description": "A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }, { "name": "armPath", "value": "armPath", "description": "An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}..." }, { "name": "ip", "value": "ip", "description": "A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y" } ] } }, "ColumnTypeEnum": { "type": "string", "description": "Column data type.", "enum": [ "string", "int", "long", "real", "boolean", "dateTime", "guid", "dynamic" ], "x-ms-enum": { "name": "ColumnTypeEnum", "modelAsString": true, "values": [ { "name": "string", "value": "string", "description": "string" }, { "name": "int", "value": "int", "description": "int" }, { "name": "long", "value": "long", "description": "long" }, { "name": "real", "value": "real", "description": "real" }, { "name": "boolean", "value": "boolean", "description": "boolean" }, { "name": "dateTime", "value": "dateTime", "description": "dateTime" }, { "name": "guid", "value": "guid", "description": "guid" }, { "name": "dynamic", "value": "dynamic", "description": "dynamic" } ] } }, "CoreSummary": { "type": "object", "description": "The core summary of a search.", "properties": { "status": { "type": "string", "description": "The status of a core summary." }, "numberOfDocuments": { "type": "integer", "format": "int64", "description": "The number of documents of a core summary." } }, "required": [ "numberOfDocuments" ] }, "DataExport": { "type": "object", "description": "The top level data export resource container.", "properties": { "properties": { "$ref": "#/definitions/DataExportProperties", "description": "data export properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "DataExportListResult": { "type": "object", "description": "Result of the request to list data exports.", "properties": { "value": { "type": "array", "description": "List of data export instances within a workspace..", "items": { "$ref": "#/definitions/DataExport" } }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } } }, "DataExportProperties": { "type": "object", "description": "Data Export properties.", "properties": { "dataExportId": { "type": "string", "description": "The data export rule ID." }, "tableNames": { "type": "array", "description": "An array of tables to export, for example: [“Heartbeat, SecurityEvent”].", "items": { "type": "string" } }, "destination": { "$ref": "#/definitions/Destination", "description": "destination properties.", "x-ms-client-flatten": true }, "enable": { "type": "boolean", "description": "Active when enabled." }, "createdDate": { "type": "string", "description": "The latest data export rule modification time." }, "lastModifiedDate": { "type": "string", "description": "Date and time when the export was last modified." } }, "required": [ "tableNames" ] }, "DataIngestionStatus": { "type": "string", "description": "The status of data ingestion for this workspace.", "enum": [ "RespectQuota", "ForceOn", "ForceOff", "OverQuota", "SubscriptionSuspended", "ApproachingQuota" ], "x-ms-enum": { "name": "DataIngestionStatus", "modelAsString": true, "values": [ { "name": "RespectQuota", "value": "RespectQuota", "description": "Ingestion enabled following daily cap quota reset, or subscription enablement." }, { "name": "ForceOn", "value": "ForceOn", "description": "Ingestion started following service setting change." }, { "name": "ForceOff", "value": "ForceOff", "description": "Ingestion stopped following service setting change." }, { "name": "OverQuota", "value": "OverQuota", "description": "Reached daily cap quota, ingestion stopped." }, { "name": "SubscriptionSuspended", "value": "SubscriptionSuspended", "description": "Ingestion stopped following suspended subscription." }, { "name": "ApproachingQuota", "value": "ApproachingQuota", "description": "80% of daily cap quota reached." } ] } }, "DataSource": { "type": "object", "description": "Datasources under OMS Workspace.", "properties": { "properties": { "description": "The data source properties in raw json format, each kind of data source have it's own schema." }, "etag": { "type": "string", "description": "The ETag of the data source." }, "kind": { "$ref": "#/definitions/DataSourceKind", "description": "The kind of the DataSource." }, "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" }, "x-ms-mutability": [ "read", "update", "create" ] } }, "required": [ "properties", "kind" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ], "x-ms-azure-resource": true }, "DataSourceKind": { "type": "string", "description": "The kind of the DataSource.", "enum": [ "WindowsEvent", "WindowsPerformanceCounter", "IISLogs", "LinuxSyslog", "LinuxSyslogCollection", "LinuxPerformanceObject", "LinuxPerformanceCollection", "CustomLog", "CustomLogCollection", "AzureAuditLog", "AzureActivityLog", "GenericDataSource", "ChangeTrackingCustomPath", "ChangeTrackingPath", "ChangeTrackingServices", "ChangeTrackingDataTypeConfiguration", "ChangeTrackingDefaultRegistry", "ChangeTrackingRegistry", "ChangeTrackingLinuxPath", "LinuxChangeTrackingPath", "ChangeTrackingContentLocation", "WindowsTelemetry", "Office365", "SecurityWindowsBaselineConfiguration", "SecurityCenterSecurityWindowsBaselineConfiguration", "SecurityEventCollectionConfiguration", "SecurityInsightsSecurityEventCollectionConfiguration", "ImportComputerGroup", "NetworkMonitoring", "Itsm", "DnsAnalytics", "ApplicationInsights", "SqlDataClassification" ], "x-ms-enum": { "name": "DataSourceKind", "modelAsString": true, "values": [ { "name": "WindowsEvent", "value": "WindowsEvent", "description": "WindowsEvent" }, { "name": "WindowsPerformanceCounter", "value": "WindowsPerformanceCounter", "description": "WindowsPerformanceCounter" }, { "name": "IISLogs", "value": "IISLogs", "description": "IISLogs" }, { "name": "LinuxSyslog", "value": "LinuxSyslog", "description": "LinuxSyslog" }, { "name": "LinuxSyslogCollection", "value": "LinuxSyslogCollection", "description": "LinuxSyslogCollection" }, { "name": "LinuxPerformanceObject", "value": "LinuxPerformanceObject", "description": "LinuxPerformanceObject" }, { "name": "LinuxPerformanceCollection", "value": "LinuxPerformanceCollection", "description": "LinuxPerformanceCollection" }, { "name": "CustomLog", "value": "CustomLog", "description": "CustomLog" }, { "name": "CustomLogCollection", "value": "CustomLogCollection", "description": "CustomLogCollection" }, { "name": "AzureAuditLog", "value": "AzureAuditLog", "description": "AzureAuditLog" }, { "name": "AzureActivityLog", "value": "AzureActivityLog", "description": "AzureActivityLog" }, { "name": "GenericDataSource", "value": "GenericDataSource", "description": "GenericDataSource" }, { "name": "ChangeTrackingCustomPath", "value": "ChangeTrackingCustomPath", "description": "ChangeTrackingCustomPath" }, { "name": "ChangeTrackingPath", "value": "ChangeTrackingPath", "description": "ChangeTrackingPath" }, { "name": "ChangeTrackingServices", "value": "ChangeTrackingServices", "description": "ChangeTrackingServices" }, { "name": "ChangeTrackingDataTypeConfiguration", "value": "ChangeTrackingDataTypeConfiguration", "description": "ChangeTrackingDataTypeConfiguration" }, { "name": "ChangeTrackingDefaultRegistry", "value": "ChangeTrackingDefaultRegistry", "description": "ChangeTrackingDefaultRegistry" }, { "name": "ChangeTrackingRegistry", "value": "ChangeTrackingRegistry", "description": "ChangeTrackingRegistry" }, { "name": "ChangeTrackingLinuxPath", "value": "ChangeTrackingLinuxPath", "description": "ChangeTrackingLinuxPath" }, { "name": "LinuxChangeTrackingPath", "value": "LinuxChangeTrackingPath", "description": "LinuxChangeTrackingPath" }, { "name": "ChangeTrackingContentLocation", "value": "ChangeTrackingContentLocation", "description": "ChangeTrackingContentLocation" }, { "name": "WindowsTelemetry", "value": "WindowsTelemetry", "description": "WindowsTelemetry" }, { "name": "Office365", "value": "Office365", "description": "Office365" }, { "name": "SecurityWindowsBaselineConfiguration", "value": "SecurityWindowsBaselineConfiguration", "description": "SecurityWindowsBaselineConfiguration" }, { "name": "SecurityCenterSecurityWindowsBaselineConfiguration", "value": "SecurityCenterSecurityWindowsBaselineConfiguration", "description": "SecurityCenterSecurityWindowsBaselineConfiguration" }, { "name": "SecurityEventCollectionConfiguration", "value": "SecurityEventCollectionConfiguration", "description": "SecurityEventCollectionConfiguration" }, { "name": "SecurityInsightsSecurityEventCollectionConfiguration", "value": "SecurityInsightsSecurityEventCollectionConfiguration", "description": "SecurityInsightsSecurityEventCollectionConfiguration" }, { "name": "ImportComputerGroup", "value": "ImportComputerGroup", "description": "ImportComputerGroup" }, { "name": "NetworkMonitoring", "value": "NetworkMonitoring", "description": "NetworkMonitoring" }, { "name": "Itsm", "value": "Itsm", "description": "Itsm" }, { "name": "DnsAnalytics", "value": "DnsAnalytics", "description": "DnsAnalytics" }, { "name": "ApplicationInsights", "value": "ApplicationInsights", "description": "ApplicationInsights" }, { "name": "SqlDataClassification", "value": "SqlDataClassification", "description": "SqlDataClassification" } ] } }, "DataSourceListResult": { "type": "object", "description": "The response of a DataSource list operation.", "properties": { "value": { "type": "array", "description": "The DataSource items on this page", "items": { "$ref": "#/definitions/DataSource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "DataSourceType": { "type": "string", "description": "Linked storage accounts type.", "enum": [ "CustomLogs", "AzureWatson", "Query", "Ingestion", "Alerts" ], "x-ms-enum": { "name": "DataSourceType", "modelAsString": false, "values": [ { "name": "CustomLogs", "value": "CustomLogs", "description": "CustomLogs" }, { "name": "AzureWatson", "value": "AzureWatson", "description": "AzureWatson" }, { "name": "Query", "value": "Query", "description": "Query" }, { "name": "Ingestion", "value": "Ingestion", "description": "Ingestion" }, { "name": "Alerts", "value": "Alerts", "description": "Alerts" } ] } }, "Destination": { "type": "object", "description": "Destination properties.", "properties": { "resourceId": { "type": "string", "description": "The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure." }, "type": { "$ref": "#/definitions/Type", "description": "The type of the destination resource", "readOnly": true }, "metaData": { "$ref": "#/definitions/DestinationMetaData", "description": "destination meta data.", "x-ms-client-flatten": true } }, "required": [ "resourceId" ] }, "DestinationMetaData": { "type": "object", "description": "Destination meta data.", "properties": { "eventHubName": { "type": "string", "description": "Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account." } } }, "Identity": { "type": "object", "description": "Identity for the resource.", "properties": { "principalId": { "type": "string", "description": "The principal ID of resource identity.", "readOnly": true }, "tenantId": { "type": "string", "description": "The tenant ID of resource.", "readOnly": true }, "type": { "$ref": "#/definitions/IdentityType", "description": "Type of managed service identity." }, "userAssignedIdentities": { "type": "object", "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", "additionalProperties": { "$ref": "#/definitions/UserIdentityProperties" } } }, "required": [ "type" ] }, "IdentityType": { "type": "string", "description": "Type of managed service identity.", "enum": [ "SystemAssigned", "UserAssigned", "None" ], "x-ms-enum": { "name": "IdentityType", "modelAsString": false, "values": [ { "name": "SystemAssigned", "value": "SystemAssigned", "description": "SystemAssigned" }, { "name": "UserAssigned", "value": "UserAssigned", "description": "UserAssigned" }, { "name": "None", "value": "None", "description": "None" } ] } }, "IntelligencePack": { "type": "object", "description": "Intelligence Pack containing a string name and boolean indicating if it's enabled.", "properties": { "name": { "type": "string", "description": "The name of the intelligence pack." }, "enabled": { "type": "boolean", "description": "The enabled boolean for the intelligence pack." }, "displayName": { "type": "string", "description": "The display name of the intelligence pack." } } }, "LinkedService": { "type": "object", "description": "The top level Linked service resource container.", "properties": { "properties": { "$ref": "#/definitions/LinkedServiceProperties", "description": "The properties of the linked service.", "x-ms-client-flatten": true }, "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" }, "x-ms-mutability": [ "read", "update", "create" ] } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "LinkedServiceEntityStatus": { "type": "string", "description": "The provisioning state of the linked service.", "enum": [ "Succeeded", "Deleting", "ProvisioningAccount", "Updating" ], "x-ms-enum": { "name": "LinkedServiceEntityStatus", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "Deleting", "value": "Deleting", "description": "Deleting" }, { "name": "ProvisioningAccount", "value": "ProvisioningAccount", "description": "ProvisioningAccount" }, { "name": "Updating", "value": "Updating", "description": "Updating" } ] } }, "LinkedServiceListResult": { "type": "object", "description": "The list linked service operation response.", "properties": { "value": { "type": "array", "description": "The list of linked service instances", "items": { "$ref": "#/definitions/LinkedService" } }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } } }, "LinkedServiceProperties": { "type": "object", "description": "Linked service properties.", "properties": { "resourceId": { "type": "string", "description": "The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require read access" }, "writeAccessResourceId": { "type": "string", "description": "The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access" }, "provisioningState": { "$ref": "#/definitions/LinkedServiceEntityStatus", "description": "The provisioning state of the linked service." } } }, "LinkedStorageAccountsListResult": { "type": "object", "description": "The list linked storage accounts service operation response.", "properties": { "value": { "type": "array", "description": "A list of linked storage accounts instances.", "items": { "$ref": "#/definitions/LinkedStorageAccountsResource" } }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } } }, "LinkedStorageAccountsProperties": { "type": "object", "description": "Linked storage accounts properties.", "properties": { "dataSourceType": { "$ref": "#/definitions/DataSourceType", "description": "Linked storage accounts type.", "readOnly": true }, "storageAccountIds": { "type": "array", "description": "Linked storage accounts resources ids.", "items": { "type": "string" } } } }, "LinkedStorageAccountsResource": { "type": "object", "description": "Linked storage accounts top level resource container.", "properties": { "properties": { "$ref": "#/definitions/LinkedStorageAccountsProperties", "description": "Linked storage accounts properties.", "x-ms-client-flatten": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "LogAnalyticsQueryPack": { "type": "object", "description": "An Log Analytics QueryPack definition.", "properties": { "properties": { "$ref": "#/definitions/LogAnalyticsQueryPackProperties", "description": "Properties that define a Log Analytics QueryPack resource.", "x-ms-client-flatten": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "LogAnalyticsQueryPackListResult": { "type": "object", "description": "The response of a LogAnalyticsQueryPack list operation.", "properties": { "value": { "type": "array", "description": "The LogAnalyticsQueryPack items on this page", "items": { "$ref": "#/definitions/LogAnalyticsQueryPack" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "LogAnalyticsQueryPackProperties": { "type": "object", "description": "Properties that define a Log Analytics QueryPack resource.", "properties": { "queryPackId": { "type": "string", "description": "The unique ID of your application. This field cannot be changed.", "readOnly": true }, "timeCreated": { "type": "string", "format": "date-time", "description": "Creation Date for the Log Analytics QueryPack, in ISO 8601 format.", "readOnly": true }, "timeModified": { "type": "string", "format": "date-time", "description": "Last modified date of the Log Analytics QueryPack, in ISO 8601 format.", "readOnly": true }, "provisioningState": { "type": "string", "description": "Current state of this QueryPack: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed.", "readOnly": true } } }, "LogAnalyticsQueryPackQuery": { "type": "object", "description": "A Log Analytics QueryPack-Query definition.", "properties": { "properties": { "$ref": "#/definitions/LogAnalyticsQueryPackQueryProperties", "description": "Properties that define an Log Analytics QueryPack-Query resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "LogAnalyticsQueryPackQueryListResult": { "type": "object", "description": "The response of a LogAnalyticsQueryPackQuery list operation.", "properties": { "value": { "type": "array", "description": "The LogAnalyticsQueryPackQuery items on this page", "items": { "$ref": "#/definitions/LogAnalyticsQueryPackQuery" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "LogAnalyticsQueryPackQueryProperties": { "type": "object", "description": "Properties that define an Log Analytics QueryPack-Query resource.", "properties": { "id": { "type": "string", "description": "The unique ID of your application. This field cannot be changed.", "readOnly": true }, "displayName": { "type": "string", "description": "Unique display name for your query within the Query Pack." }, "timeCreated": { "type": "string", "format": "date-time", "description": "Creation Date for the Log Analytics Query, in ISO 8601 format.", "readOnly": true }, "timeModified": { "type": "string", "format": "date-time", "description": "Last modified date of the Log Analytics Query, in ISO 8601 format.", "readOnly": true }, "author": { "type": "string", "description": "Object Id of user creating the query.", "readOnly": true }, "description": { "type": "string", "description": "Description of the query." }, "body": { "type": "string", "description": "Body of the query." }, "related": { "$ref": "#/definitions/LogAnalyticsQueryPackQueryPropertiesRelated", "description": "The related metadata items for the function." }, "tags": { "type": "object", "description": "Tags associated with the query.", "additionalProperties": { "items": { "type": "string" }, "type": "array" } }, "properties": { "description": "Additional properties that can be set for the query." } }, "required": [ "displayName", "body" ] }, "LogAnalyticsQueryPackQueryPropertiesRelated": { "type": "object", "description": "The related metadata items for the function.", "properties": { "categories": { "type": "array", "description": "The related categories for the function.", "items": { "type": "string" } }, "resourceTypes": { "type": "array", "description": "The related resource types for the function.", "items": { "type": "string" } }, "solutions": { "type": "array", "description": "The related Log Analytics solutions for the function.", "items": { "type": "string" } } } }, "LogAnalyticsQueryPackQuerySearchProperties": { "type": "object", "description": "Properties that define an Log Analytics QueryPack-Query search properties.", "properties": { "related": { "$ref": "#/definitions/LogAnalyticsQueryPackQuerySearchPropertiesRelated", "description": "The related metadata items for the function." }, "tags": { "type": "object", "description": "Tags associated with the query.", "additionalProperties": { "items": { "type": "string" }, "type": "array" } } } }, "LogAnalyticsQueryPackQuerySearchPropertiesRelated": { "type": "object", "description": "The related metadata items for the function.", "properties": { "categories": { "type": "array", "description": "The related categories for the function.", "items": { "type": "string" } }, "resourceTypes": { "type": "array", "description": "The related resource types for the function.", "items": { "type": "string" } }, "solutions": { "type": "array", "description": "The related Log Analytics solutions for the function.", "items": { "type": "string" } } } }, "ManagementGroup": { "type": "object", "description": "A management group that is connected to a workspace", "properties": { "properties": { "$ref": "#/definitions/ManagementGroupProperties", "description": "The properties of the management group.", "x-ms-client-flatten": true } } }, "ManagementGroupProperties": { "type": "object", "description": "Management group properties.", "properties": { "serverCount": { "type": "integer", "format": "int32", "description": "The number of servers connected to the management group." }, "isGateway": { "type": "boolean", "description": "Gets or sets a value indicating whether the management group is a gateway." }, "name": { "type": "string", "description": "The name of the management group." }, "id": { "type": "string", "description": "The unique ID of the management group." }, "created": { "type": "string", "format": "date-time", "description": "The datetime that the management group was created." }, "dataReceived": { "type": "string", "format": "date-time", "description": "The last datetime that the management group received data." }, "version": { "type": "string", "description": "The version of System Center that is managing the management group." }, "sku": { "type": "string", "description": "The SKU of System Center that is managing the management group." } } }, "MetricName": { "type": "object", "description": "The name of a metric.", "properties": { "value": { "type": "string", "description": "The system name of the metric." }, "localizedValue": { "type": "string", "description": "The localized name of the metric." } } }, "Operation": { "type": "object", "description": "Supported operation of OperationalInsights resource provider.", "properties": { "name": { "type": "string", "description": "Operation name: {provider}/{resource}/{operation}" }, "display": { "$ref": "#/definitions/OperationDisplay", "description": "Display metadata associated with the operation." } } }, "OperationDisplay": { "type": "object", "description": "Display metadata associated with the operation.", "properties": { "provider": { "type": "string", "description": "Service provider: Microsoft OperationsManagement." }, "resource": { "type": "string", "description": "Resource on which the operation is performed etc." }, "operation": { "type": "string", "description": "Type of operation: get, read, delete, etc." }, "description": { "type": "string", "description": "Description of operation" } } }, "OperationListResult": { "type": "object", "description": "Paged collection of Operation items", "properties": { "value": { "type": "array", "description": "The Operation items on this page", "items": { "$ref": "#/definitions/Operation" }, "x-ms-identifiers": [ "name" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "OperationStatus": { "type": "object", "description": "The status of operation.", "properties": { "id": { "type": "string", "description": "The operation Id." }, "name": { "type": "string", "description": "The operation name." }, "startTime": { "type": "string", "description": "The start time of the operation." }, "endTime": { "type": "string", "description": "The end time of the operation." }, "status": { "type": "string", "description": "The status of the operation." }, "error": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse", "description": "The error detail of the operation if any." } } }, "OperationalInsightsTableProvisioningState": { "type": "string", "description": "Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded.", "enum": [ "Updating", "InProgress", "Succeeded", "Deleting" ], "x-ms-enum": { "name": "OperationalInsightsTableProvisioningState", "modelAsString": true, "values": [ { "name": "Updating", "value": "Updating", "description": "Table schema is still being built and updated, table is currently locked for any changes till the procedure is done." }, { "name": "InProgress", "value": "InProgress", "description": "Table schema is stable and without changes, table data is being updated." }, { "name": "Succeeded", "value": "Succeeded", "description": "Table state is stable and without changes, table is unlocked and open for new updates." }, { "name": "Deleting", "value": "Deleting", "description": "Table state is deleting." } ] } }, "PrivateLinkScopedResource": { "type": "object", "description": "The private link scope resource reference.", "properties": { "resourceId": { "type": "string", "description": "The full resource Id of the private link scope resource." }, "scopeId": { "type": "string", "description": "The private link scope unique Identifier." } } }, "ProvisioningStateEnum": { "type": "string", "description": "Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded.", "enum": [ "Updating", "Succeeded", "Deleting", "Failed", "Canceled" ], "x-ms-enum": { "name": "ProvisioningStateEnum", "modelAsString": true, "values": [ { "name": "Updating", "value": "Updating", "description": "Table schema is still being built and updated, table is currently locked for any changes till the procedure is done." }, { "name": "Succeeded", "value": "Succeeded", "description": "Table state is stable and without changes, table is unlocked and open for new updates." }, { "name": "Deleting", "value": "Deleting", "description": "Table state is deleting." }, { "name": "Failed", "value": "Failed", "description": "Table state is failed." }, { "name": "Canceled", "value": "Canceled", "description": "Table state is canceled." } ] } }, "PurgeState": { "type": "string", "description": "Status of the operation represented by the requested Id.", "enum": [ "pending", "completed" ], "x-ms-enum": { "name": "PurgeState", "modelAsString": true, "values": [ { "name": "pending", "value": "pending", "description": "pending" }, { "name": "completed", "value": "completed", "description": "completed" } ] } }, "RestoredLogs": { "type": "object", "description": "Restore parameters.", "properties": { "startRestoreTime": { "type": "string", "format": "date-time", "description": "The timestamp to start the restore from (UTC)." }, "endRestoreTime": { "type": "string", "format": "date-time", "description": "The timestamp to end the restore by (UTC)." }, "sourceTable": { "type": "string", "description": "The table to restore data from." }, "azureAsyncOperationId": { "type": "string", "description": "Search results table async operation id.", "readOnly": true } } }, "ResultStatistics": { "type": "object", "description": "Search job execution statistics.", "properties": { "progress": { "type": "number", "format": "float", "description": "Search job completion percentage.", "readOnly": true }, "ingestedRecords": { "type": "integer", "format": "int32", "description": "The number of rows that were returned by the search job.", "readOnly": true }, "scannedGb": { "type": "number", "format": "float", "description": "Search job: Amount of scanned data.", "readOnly": true } } }, "RuleDefinition": { "type": "object", "description": "Rule definition parameters.", "properties": { "query": { "type": "string", "description": "Summary rule query." }, "binSize": { "type": "integer", "format": "int32", "description": "Scheduled window in minutes. Allowed values: 20, 30, 60, 120, 180, 360, 720, 1440." }, "binDelay": { "type": "integer", "format": "int32", "description": "The minimum delay in seconds before bin processing." }, "binStartTime": { "type": "string", "format": "date-time", "description": "The start time (UTC) when Summary rule execution starts." }, "timeSelector": { "$ref": "#/definitions/TimeSelectorEnum", "description": "The time cursor used in Summary rules bins processing, e.g. TimeGenerated." }, "destinationTable": { "type": "string", "description": "The destination table used for the Summary rule results." } } }, "RuleTypeEnum": { "type": "string", "description": "SummaryRules rule type: User.", "enum": [ "User" ], "x-ms-enum": { "name": "RuleTypeEnum", "modelAsString": true, "values": [ { "name": "User", "value": "User", "description": "User defined summary rule. This is the definition for rules created and defined by users." } ] } }, "SavedSearch": { "type": "object", "description": "Value object for saved search results.", "properties": { "properties": { "$ref": "#/definitions/SavedSearchProperties", "description": "The properties of the saved search.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "The ETag of the saved search. To override an existing saved search, use \"*\" or specify the current Etag" } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "SavedSearchProperties": { "type": "object", "description": "Value object for saved search results.", "properties": { "category": { "type": "string", "description": "The category of the saved search. This helps the user to find a saved search faster." }, "displayName": { "type": "string", "description": "Saved search display name." }, "query": { "type": "string", "description": "The query expression for the saved search." }, "functionAlias": { "type": "string", "description": "The function alias if query serves as a function." }, "functionParameters": { "type": "string", "description": "The optional function parameters if query serves as a function. Value should be in the following format: 'param-name1:type1 = default_value1, param-name2:type2 = default_value2'. For more examples and proper syntax please refer to https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions." }, "version": { "type": "integer", "format": "int64", "description": "The version number of the query language. The current version is 2 and is the default." }, "tags": { "type": "array", "description": "The tags attached to the saved search.", "items": { "$ref": "#/definitions/Tag" }, "x-ms-identifiers": [ "name" ] } }, "required": [ "category", "displayName", "query" ] }, "SavedSearchesListResult": { "type": "object", "description": "The saved search list operation response.", "properties": { "value": { "type": "array", "description": "The array of result values.", "items": { "$ref": "#/definitions/SavedSearch" } } } }, "Schema": { "type": "object", "description": "Table's schema.", "properties": { "name": { "type": "string", "description": "Table name." }, "displayName": { "type": "string", "description": "Table display name." }, "description": { "type": "string", "description": "Table description." }, "columns": { "type": "array", "description": "A list of table custom columns.", "items": { "$ref": "#/definitions/Column" }, "x-ms-identifiers": [ "name" ] }, "standardColumns": { "type": "array", "description": "A list of table standard columns.", "items": { "$ref": "#/definitions/Column" }, "readOnly": true, "x-ms-identifiers": [ "name" ] }, "categories": { "type": "array", "description": "Table category.", "items": { "type": "string" }, "readOnly": true }, "labels": { "type": "array", "description": "Table labels.", "items": { "type": "string" }, "readOnly": true }, "source": { "$ref": "#/definitions/SourceEnum", "description": "Table's creator.", "readOnly": true }, "tableType": { "$ref": "#/definitions/TableTypeEnum", "description": "Table's creator.", "readOnly": true }, "tableSubType": { "$ref": "#/definitions/TableSubTypeEnum", "description": "The subtype describes what APIs can be used to interact with the table, and what features are available against it.", "readOnly": true }, "solutions": { "type": "array", "description": "List of solutions the table is affiliated with", "items": { "type": "string" }, "readOnly": true } } }, "SearchGetSchemaResponse": { "type": "object", "description": "The get schema operation response.", "properties": { "metadata": { "$ref": "#/definitions/SearchMetadata", "description": "The metadata from search results.", "x-ms-client-name": "Metadata" }, "value": { "type": "array", "description": "The array of result values.", "items": { "$ref": "#/definitions/SearchSchemaValue" }, "x-ms-identifiers": [ "name" ] } } }, "SearchMetadata": { "type": "object", "description": "Metadata for search results.", "properties": { "requestId": { "type": "string", "description": "The request id of the search.", "x-ms-client-name": "SearchId" }, "resultType": { "type": "string", "description": "The search result type." }, "total": { "type": "integer", "format": "int64", "description": "The total number of search results." }, "top": { "type": "integer", "format": "int64", "description": "The number of top search results." }, "id": { "type": "string", "description": "The id of the search results request." }, "coreSummaries": { "type": "array", "description": "The core summaries.", "items": { "$ref": "#/definitions/CoreSummary" }, "x-ms-identifiers": [] }, "status": { "type": "string", "description": "The status of the search results." }, "startTime": { "type": "string", "format": "date-time", "description": "The start time for the search." }, "lastUpdated": { "type": "string", "format": "date-time", "description": "The time of last update." }, "eTag": { "type": "string", "description": "The ETag of the search results." }, "sort": { "type": "array", "description": "How the results are sorted.", "items": { "$ref": "#/definitions/SearchSort" }, "x-ms-identifiers": [ "name" ] }, "requestTime": { "type": "integer", "format": "int64", "description": "The request time." }, "aggregatedValueField": { "type": "string", "description": "The aggregated value field." }, "aggregatedGroupingFields": { "type": "string", "description": "The aggregated grouping fields." }, "sum": { "type": "integer", "format": "int64", "description": "The sum of all aggregates returned in the result set." }, "max": { "type": "integer", "format": "int64", "description": "The max of all aggregates returned in the result set." }, "schema": { "$ref": "#/definitions/SearchMetadataSchema", "description": "The schema." } } }, "SearchMetadataSchema": { "type": "object", "description": "Schema metadata for search.", "properties": { "name": { "type": "string", "description": "The name of the metadata schema." }, "version": { "type": "integer", "format": "int32", "description": "The version of the metadata schema." } } }, "SearchResults": { "type": "object", "description": "Parameters of the search job that initiated this table.", "properties": { "query": { "type": "string", "description": "Search job query." }, "description": { "type": "string", "description": "Search job Description." }, "limit": { "type": "integer", "format": "int32", "description": "Limit the search job to return up to specified number of rows." }, "startSearchTime": { "type": "string", "format": "date-time", "description": "The timestamp to start the search from (UTC)" }, "endSearchTime": { "type": "string", "format": "date-time", "description": "The timestamp to end the search by (UTC)" }, "sourceTable": { "type": "string", "description": "The table used in the search job.", "readOnly": true }, "azureAsyncOperationId": { "type": "string", "description": "Search results table async operation id.", "readOnly": true } } }, "SearchSchemaValue": { "type": "object", "description": "Value object for schema results.", "properties": { "name": { "type": "string", "description": "The name of the schema." }, "displayName": { "type": "string", "description": "The display name of the schema." }, "type": { "type": "string", "description": "The type." }, "indexed": { "type": "boolean", "description": "The boolean that indicates the field is searchable as free text." }, "stored": { "type": "boolean", "description": "The boolean that indicates whether or not the field is stored." }, "facet": { "type": "boolean", "description": "The boolean that indicates whether or not the field is a facet." }, "ownerType": { "type": "array", "description": "The array of workflows containing the field.", "items": { "type": "string" } } }, "required": [ "indexed", "stored", "facet" ] }, "SearchSort": { "type": "object", "description": "The sort parameters for search.", "properties": { "name": { "type": "string", "description": "The name of the field the search query is sorted on." }, "order": { "$ref": "#/definitions/SearchSortEnum", "description": "The sort order of the search." } } }, "SearchSortEnum": { "type": "string", "description": "The sort order of the search.", "enum": [ "asc", "desc" ], "x-ms-enum": { "name": "SearchSortEnum", "modelAsString": true, "values": [ { "name": "asc", "value": "asc", "description": "asc" }, { "name": "desc", "value": "desc", "description": "desc" } ] } }, "SharedKeys": { "type": "object", "description": "The shared keys for a workspace.", "properties": { "primarySharedKey": { "type": "string", "description": "The primary shared key of a workspace." }, "secondarySharedKey": { "type": "string", "description": "The secondary shared key of a workspace." } } }, "SkuNameEnum": { "type": "string", "description": "The name of the Service Tier.", "enum": [ "Free", "Standard", "Premium", "PerNode", "PerGB2018", "Standalone", "CapacityReservation" ], "x-ms-enum": { "name": "SkuNameEnum", "modelAsString": true, "values": [ { "name": "Free", "value": "Free", "description": "Free" }, { "name": "Standard", "value": "Standard", "description": "Standard" }, { "name": "Premium", "value": "Premium", "description": "Premium" }, { "name": "PerNode", "value": "PerNode", "description": "PerNode" }, { "name": "PerGB2018", "value": "PerGB2018", "description": "PerGB2018" }, { "name": "Standalone", "value": "Standalone", "description": "Standalone" }, { "name": "CapacityReservation", "value": "CapacityReservation", "description": "CapacityReservation" } ] } }, "SourceEnum": { "type": "string", "description": "Table's creator.", "enum": [ "microsoft", "customer" ], "x-ms-enum": { "name": "SourceEnum", "modelAsString": true, "values": [ { "name": "microsoft", "value": "microsoft", "description": "Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means." }, { "name": "customer", "value": "customer", "description": "Tables created by the owner of the Workspace, and only found in this Workspace." } ] } }, "StatusCodeEnum": { "type": "string", "description": "Indicates the reason for rule deactivation.", "enum": [ "UserAction", "DataPlaneError" ], "x-ms-enum": { "name": "StatusCodeEnum", "modelAsString": true, "values": [ { "name": "UserAction", "value": "UserAction", "description": "Summary rule stop originated from a user action (Stop was called)." }, { "name": "DataPlaneError", "value": "DataPlaneError", "description": "Summary rule stop was caused due to data plane related error." } ] } }, "StorageAccount": { "type": "object", "description": "Describes a storage account connection.", "properties": { "id": { "type": "string", "description": "The Azure Resource Manager ID of the storage account resource." }, "key": { "type": "string", "description": "The storage account key." } }, "required": [ "id", "key" ] }, "StorageInsight": { "type": "object", "description": "The top level storage insight resource container.", "properties": { "properties": { "$ref": "#/definitions/StorageInsightProperties", "description": "Storage insight properties.", "x-ms-client-flatten": true }, "eTag": { "type": "string", "description": "The ETag of the storage insight." }, "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" }, "x-ms-mutability": [ "read", "update", "create" ] } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "StorageInsightListResult": { "type": "object", "description": "The list storage insights operation response.", "properties": { "value": { "type": "array", "description": "A list of storage insight items.", "items": { "$ref": "#/definitions/StorageInsight" } }, "@odata.nextLink": { "type": "string", "description": "The link (url) to the next page of results.", "x-ms-client-name": "odataNextLink" } } }, "StorageInsightProperties": { "type": "object", "description": "Storage insight properties.", "properties": { "containers": { "type": "array", "description": "The names of the blob containers that the workspace should read", "items": { "type": "string" } }, "tables": { "type": "array", "description": "The names of the Azure tables that the workspace should read", "items": { "type": "string" } }, "storageAccount": { "$ref": "#/definitions/StorageAccount", "description": "The storage account connection details" }, "status": { "$ref": "#/definitions/StorageInsightStatus", "description": "The status of the storage insight", "readOnly": true } }, "required": [ "storageAccount" ] }, "StorageInsightState": { "type": "string", "description": "The state of the storage insight connection to the workspace", "enum": [ "OK", "ERROR" ], "x-ms-enum": { "name": "StorageInsightState", "modelAsString": true, "values": [ { "name": "OK", "value": "OK", "description": "OK" }, { "name": "ERROR", "value": "ERROR", "description": "ERROR" } ] } }, "StorageInsightStatus": { "type": "object", "description": "The status of the storage insight.", "properties": { "state": { "$ref": "#/definitions/StorageInsightState", "description": "The state of the storage insight connection to the workspace" }, "description": { "type": "string", "description": "Description of the state of the storage insight." } }, "required": [ "state" ] }, "SummaryLogs": { "type": "object", "description": "Workspace data summary rules definition.", "properties": { "properties": { "$ref": "#/definitions/SummaryLogsProperties", "description": "Summary rule properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "SummaryLogsListResult": { "type": "object", "description": "The response of a SummaryLogs list operation.", "properties": { "value": { "type": "array", "description": "The SummaryLogs items on this page", "items": { "$ref": "#/definitions/SummaryLogs" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SummaryLogsProperties": { "type": "object", "description": "Summary rule properties.", "properties": { "ruleType": { "$ref": "#/definitions/RuleTypeEnum", "description": "SummaryRules rule type: User." }, "displayName": { "type": "string", "description": "The display name of the Summary rule." }, "description": { "type": "string", "description": "The description of the Summary rule." }, "isActive": { "type": "boolean", "description": "Indicates if Summary rule is active. If not, Summary rule execution stops.", "readOnly": true }, "statusCode": { "$ref": "#/definitions/StatusCodeEnum", "description": "Indicates the reason for rule deactivation.", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningStateEnum", "description": "Summary rule is in provisioning state. If set to 'updating' or 'deleting', indicates a resource lock due to an ongoing operation, preventing any update to the Summary rule until the operation is complete.", "readOnly": true }, "ruleDefinition": { "$ref": "#/definitions/RuleDefinition", "description": "Rule definition parameters." } } }, "SummaryLogsRetryBin": { "type": "object", "description": "Request to retry a summary logs bin.", "properties": { "properties": { "$ref": "#/definitions/SummaryLogsRetryBinProperties", "description": "Retry bin properties." } } }, "SummaryLogsRetryBinProperties": { "type": "object", "description": "Properties for retrying a Summary rule bin.", "properties": { "retryBinStartTime": { "type": "string", "format": "date-time", "description": "The time (UTC) of the bin to retry." } }, "required": [ "retryBinStartTime" ] }, "Table": { "type": "object", "description": "Workspace data table definition.", "properties": { "properties": { "$ref": "#/definitions/TableProperties", "description": "Table's properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "TablePlanEnum": { "type": "string", "description": "Instruct the system how to handle and charge the logs ingested to this table.", "enum": [ "Basic", "Analytics", "Auxiliary" ], "x-ms-enum": { "name": "TablePlanEnum", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Medium-touch logs needed for troubleshooting and incident response." }, { "name": "Analytics", "value": "Analytics", "description": "High-value logs used for continuous monitoring, real-time detection, and performance analytics." }, { "name": "Auxiliary", "value": "Auxiliary", "description": "Low-touch logs, such as verbose logs, and data required for auditing and compliance." } ] } }, "TableProperties": { "type": "object", "description": "Table properties.", "properties": { "retentionInDays": { "type": "integer", "format": "int32", "description": "In Analytics table: the tables analytics retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. In Basic and Auxiliary table: read only property.", "minimum": 4, "maximum": 730 }, "totalRetentionInDays": { "type": "integer", "format": "int32", "description": "The table total retention in days, between 4 and 4383. Setting this property to -1 will default to retentionInDays.", "minimum": 4, "maximum": 4383 }, "archiveRetentionInDays": { "type": "integer", "format": "int32", "description": "The tables long-term retention in days. Calculated as (totalRetentionInDays-retentionInDays).", "readOnly": true }, "searchResults": { "$ref": "#/definitions/SearchResults", "description": "Parameters of the search job that initiated this table." }, "restoredLogs": { "$ref": "#/definitions/RestoredLogs", "description": "Parameters of the restore operation that initiated this table." }, "resultStatistics": { "$ref": "#/definitions/ResultStatistics", "description": "Search job execution statistics.", "readOnly": true }, "plan": { "$ref": "#/definitions/TablePlanEnum", "description": "Instruct the system how to handle and charge the logs ingested to this table." }, "lastPlanModifiedDate": { "type": "string", "description": "The timestamp that table plan was last modified (UTC).", "readOnly": true }, "schema": { "$ref": "#/definitions/Schema", "description": "Table schema." }, "provisioningState": { "$ref": "#/definitions/OperationalInsightsTableProvisioningState", "description": "Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded.", "readOnly": true }, "retentionInDaysAsDefault": { "type": "boolean", "description": "True - Value originates from workspace retention in days, False - Customer specific.", "readOnly": true }, "totalRetentionInDaysAsDefault": { "type": "boolean", "description": "True - Value originates from retention in days, False - Customer specific.", "readOnly": true } } }, "TableSubTypeEnum": { "type": "string", "description": "The subtype describes what APIs can be used to interact with the table, and what features are available against it.", "enum": [ "Any", "Classic", "DataCollectionRuleBased" ], "x-ms-enum": { "name": "TableSubTypeEnum", "modelAsString": true, "values": [ { "name": "Any", "value": "Any", "description": "The default subtype with which built-in tables are created." }, { "name": "Classic", "value": "Classic", "description": "Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created." }, { "name": "DataCollectionRuleBased", "value": "DataCollectionRuleBased", "description": "A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules" } ] } }, "TableTypeEnum": { "type": "string", "description": "Table's creator.", "enum": [ "Microsoft", "CustomLog", "RestoredLogs", "SearchResults" ], "x-ms-enum": { "name": "TableTypeEnum", "modelAsString": true, "values": [ { "name": "Microsoft", "value": "Microsoft", "description": "Standard data collected by Azure Monitor." }, { "name": "CustomLog", "value": "CustomLog", "description": "Custom log table." }, { "name": "RestoredLogs", "value": "RestoredLogs", "description": "Restored data." }, { "name": "SearchResults", "value": "SearchResults", "description": "Data collected by a search job." } ] } }, "TablesListResult": { "type": "object", "description": "The list tables operation response.", "properties": { "value": { "type": "array", "description": "A list of data tables.", "items": { "$ref": "#/definitions/Table" } }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } } }, "Tag": { "type": "object", "description": "A tag of a saved search.", "properties": { "name": { "type": "string", "description": "The tag name." }, "value": { "type": "string", "description": "The tag value." } }, "required": [ "name", "value" ] }, "TagsResource": { "type": "object", "description": "A container holding only the Tags for a resource, allowing the user to update the tags on a QueryPack instance.", "properties": { "tags": { "type": "object", "description": "Resource tags", "additionalProperties": { "type": "string" } } } }, "TimeSelectorEnum": { "type": "string", "description": "The time cursor used in Summary rules bins processing, e.g. TimeGenerated.", "enum": [ "TimeGenerated" ], "x-ms-enum": { "name": "TimeSelectorEnum", "modelAsString": true, "values": [ { "name": "TimeGenerated", "value": "TimeGenerated", "description": "TimeGenerated." } ] } }, "Type": { "type": "string", "description": "The type of the destination resource", "enum": [ "StorageAccount", "EventHub" ], "x-ms-enum": { "name": "Type", "modelAsString": true, "values": [ { "name": "StorageAccount", "value": "StorageAccount", "description": "StorageAccount" }, { "name": "EventHub", "value": "EventHub", "description": "EventHub" } ] } }, "UsageMetric": { "type": "object", "description": "A metric describing the usage of a resource.", "properties": { "name": { "$ref": "#/definitions/MetricName", "description": "The name of the metric." }, "unit": { "type": "string", "description": "The units used for the metric." }, "currentValue": { "type": "number", "format": "double", "description": "The current value of the metric." }, "limit": { "type": "number", "format": "double", "description": "The quota limit for the metric." }, "nextResetTime": { "type": "string", "format": "date-time", "description": "The time that the metric's value will reset." }, "quotaPeriod": { "type": "string", "description": "The quota period that determines the length of time between value resets." } } }, "UserIdentityProperties": { "type": "object", "description": "User assigned identity properties.", "properties": { "principalId": { "type": "string", "description": "The principal id of user assigned identity.", "readOnly": true }, "clientId": { "type": "string", "description": "The client id of user assigned identity.", "readOnly": true } } }, "Workspace": { "type": "object", "description": "The top level Workspace resource container.", "properties": { "properties": { "$ref": "#/definitions/WorkspaceProperties", "description": "Workspace properties.", "x-ms-client-flatten": true }, "identity": { "$ref": "#/definitions/Identity", "description": "The identity of the resource." }, "etag": { "type": "string", "description": "The etag of the workspace." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "WorkspaceCapping": { "type": "object", "description": "The daily volume cap for ingestion.", "properties": { "dailyQuotaGb": { "type": "number", "format": "double", "description": "The workspace daily quota for ingestion." }, "quotaNextResetTime": { "type": "string", "description": "The time when the quota will be rest.", "readOnly": true }, "dataIngestionStatus": { "$ref": "#/definitions/DataIngestionStatus", "description": "The status of data ingestion for this workspace.", "readOnly": true } } }, "WorkspaceEntityStatus": { "type": "string", "description": "The provisioning state of the workspace.", "enum": [ "Creating", "Succeeded", "Failed", "Canceled", "Deleting", "ProvisioningAccount", "Updating" ], "x-ms-enum": { "name": "WorkspaceEntityStatus", "modelAsString": true, "values": [ { "name": "Creating", "value": "Creating", "description": "Creating" }, { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Canceled", "value": "Canceled", "description": "Canceled" }, { "name": "Deleting", "value": "Deleting", "description": "Deleting" }, { "name": "ProvisioningAccount", "value": "ProvisioningAccount", "description": "ProvisioningAccount" }, { "name": "Updating", "value": "Updating", "description": "Updating" } ] } }, "WorkspaceFailoverProperties": { "type": "object", "description": "The failover state of the replication.", "properties": { "state": { "$ref": "#/definitions/WorkspaceFailoverState", "description": "The failover state of the replication.", "readOnly": true }, "lastModifiedDate": { "type": "string", "format": "date-time", "description": "The last time when the failover state was updated.", "readOnly": true } } }, "WorkspaceFailoverState": { "type": "string", "description": "The failover state of the replication.", "enum": [ "Inactive", "Activating", "Active", "Deactivating", "Failed" ], "x-ms-enum": { "name": "WorkspaceFailoverState", "modelAsString": true, "values": [ { "name": "Inactive", "value": "Inactive", "description": "Inactive" }, { "name": "Activating", "value": "Activating", "description": "Activating" }, { "name": "Active", "value": "Active", "description": "Active" }, { "name": "Deactivating", "value": "Deactivating", "description": "Deactivating" }, { "name": "Failed", "value": "Failed", "description": "Failed" } ] } }, "WorkspaceFeatures": { "type": "object", "description": "Workspace features.", "properties": { "enableDataExport": { "type": "boolean", "description": "Flag that indicate if data should be exported.", "x-nullable": true }, "immediatePurgeDataOn30Days": { "type": "boolean", "description": "Flag that describes if we want to remove the data after 30 days.", "x-nullable": true }, "enableLogAccessUsingOnlyResourcePermissions": { "type": "boolean", "description": "Flag that indicate which permission to use - resource or workspace or both.", "x-nullable": true }, "clusterResourceId": { "type": "string", "description": "Dedicated LA cluster resourceId that is linked to the workspaces.", "x-nullable": true }, "disableLocalAuth": { "type": "boolean", "description": "Disable Non-AAD based Auth.", "x-nullable": true }, "unifiedSentinelBillingOnly": { "type": "boolean", "description": "An indication if the specify workspace is limited to sentinel's unified billing model only.", "x-nullable": true, "readOnly": true }, "associations": { "type": "array", "description": "List of associations for the workspace. Indicates if the workspace is associated with any of the following experiences: MDC, Sentinel, SentinelGraph, etc.", "items": { "type": "string" }, "readOnly": true } }, "additionalProperties": {} }, "WorkspaceListManagementGroupsResult": { "type": "object", "description": "The list workspace management groups operation response.", "properties": { "value": { "type": "array", "description": "Gets or sets a list of management groups attached to the workspace.", "items": { "$ref": "#/definitions/ManagementGroup" }, "x-ms-identifiers": [ "/properties/id" ] }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } } }, "WorkspaceListResult": { "type": "object", "description": "The list workspaces operation response.", "properties": { "value": { "type": "array", "description": "A list of workspaces.", "items": { "$ref": "#/definitions/Workspace" } }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } } }, "WorkspaceListUsagesResult": { "type": "object", "description": "The list workspace usages operation response.", "properties": { "value": { "type": "array", "description": "Gets or sets a list of usage metrics for a workspace.", "items": { "$ref": "#/definitions/UsageMetric" }, "x-ms-identifiers": [ "name" ] }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } } }, "WorkspacePatch": { "type": "object", "description": "The top level Workspace resource container.", "properties": { "properties": { "$ref": "#/definitions/WorkspaceProperties", "description": "Workspace properties.", "x-ms-client-flatten": true }, "identity": { "$ref": "#/definitions/Identity", "description": "The identity of the resource." }, "tags": { "type": "object", "description": "Resource tags. Optional.", "additionalProperties": { "type": "string" }, "x-ms-mutability": [ "read", "update", "create" ] } }, "allOf": [ { "$ref": "#/definitions/AzureEntityResource" } ] }, "WorkspaceProperties": { "type": "object", "description": "Workspace properties.", "properties": { "provisioningState": { "$ref": "#/definitions/WorkspaceEntityStatus", "description": "The provisioning state of the workspace.", "readOnly": true }, "customerId": { "type": "string", "description": "This is a read-only property. Represents the ID associated with the workspace.", "readOnly": true }, "sku": { "$ref": "#/definitions/WorkspaceSku", "description": "The SKU of the workspace." }, "retentionInDays": { "type": "integer", "format": "int32", "description": "The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.", "x-nullable": true }, "workspaceCapping": { "$ref": "#/definitions/WorkspaceCapping", "description": "The daily volume cap for ingestion." }, "createdDate": { "type": "string", "format": "date-time", "description": "Workspace creation date.", "readOnly": true }, "modifiedDate": { "type": "string", "format": "date-time", "description": "Workspace modification date.", "readOnly": true }, "publicNetworkAccessForIngestion": { "type": "string", "description": "The network access type for accessing Log Analytics ingestion.", "default": "Enabled", "enum": [ "Enabled", "Disabled", "SecuredByPerimeter" ], "x-ms-enum": { "name": "PublicNetworkAccessType", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled", "description": "Enables connectivity to Log Analytics through public DNS." }, { "name": "Disabled", "value": "Disabled", "description": "Disables public connectivity to Log Analytics through public DNS." }, { "name": "SecuredByPerimeter", "value": "SecuredByPerimeter", "description": "Resource is only accessible from private networks and access approved by network security perimeter associated to this resource." } ] } }, "publicNetworkAccessForQuery": { "type": "string", "description": "The network access type for accessing Log Analytics query.", "default": "Enabled", "enum": [ "Enabled", "Disabled", "SecuredByPerimeter" ], "x-ms-enum": { "name": "PublicNetworkAccessType", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled", "description": "Enables connectivity to Log Analytics through public DNS." }, { "name": "Disabled", "value": "Disabled", "description": "Disables public connectivity to Log Analytics through public DNS." }, { "name": "SecuredByPerimeter", "value": "SecuredByPerimeter", "description": "Resource is only accessible from private networks and access approved by network security perimeter associated to this resource." } ] } }, "forceCmkForQuery": { "type": "boolean", "description": "Indicates whether customer managed storage is mandatory for query management." }, "privateLinkScopedResources": { "type": "array", "description": "List of linked private link scope resources.", "items": { "$ref": "#/definitions/PrivateLinkScopedResource" }, "readOnly": true, "x-ms-identifiers": [ "resourceId" ] }, "features": { "$ref": "#/definitions/WorkspaceFeatures", "description": "Workspace features." }, "defaultDataCollectionRuleResourceId": { "type": "string", "description": "The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}." }, "replication": { "$ref": "#/definitions/WorkspaceReplicationProperties", "description": "workspace replication properties." }, "failover": { "$ref": "#/definitions/WorkspaceFailoverProperties", "description": "workspace failover properties." } } }, "WorkspacePurgeBody": { "type": "object", "description": "Describes the body of a purge request for an App Insights Workspace", "properties": { "table": { "type": "string", "description": "Table from which to purge data." }, "filters": { "type": "array", "description": "The set of columns and filters (queries) to run over them to purge the resulting data.", "items": { "$ref": "#/definitions/WorkspacePurgeBodyFilters" }, "x-ms-identifiers": [] } }, "required": [ "table", "filters" ] }, "WorkspacePurgeBodyFilters": { "type": "object", "description": "User-defined filters to return data which will be purged from the table.", "properties": { "column": { "type": "string", "description": "The column of the table over which the given query should run" }, "operator": { "type": "string", "description": "A query operator to evaluate over the provided column and value(s). Supported operators are ==, =~, in, in~, >, >=, <, <=, between, and have the same behavior as they would in a KQL query." }, "value": { "description": "the value for the operator to function over. This can be a number (e.g., > 100), a string (timestamp >= '2017-09-01') or array of values." }, "key": { "type": "string", "description": "When filtering over custom dimensions, this key will be used as the name of the custom dimension." } } }, "WorkspacePurgeResponse": { "type": "object", "description": "Response containing operationId for a specific purge action.", "properties": { "operationId": { "type": "string", "description": "Id to use when querying for status for a particular purge operation." } }, "required": [ "operationId" ] }, "WorkspacePurgeStatusResponse": { "type": "object", "description": "Response containing status for a specific purge operation.", "properties": { "status": { "$ref": "#/definitions/PurgeState", "description": "Status of the operation represented by the requested Id." } }, "required": [ "status" ] }, "WorkspaceReplicationProperties": { "type": "object", "description": "Workspace replication properties.", "properties": { "location": { "type": "string", "description": "The location of the replication.", "x-ms-mutability": [ "read", "create" ] }, "enabled": { "type": "boolean", "description": "Specifies whether the replication is enabled or not. When true, workspace configuration and data is replicated to the specified location. If replication is been enabled, location must be provided." }, "provisioningState": { "$ref": "#/definitions/WorkspaceReplicationState", "description": "The provisioning state of the replication.", "readOnly": true }, "createdDate": { "type": "string", "format": "date-time", "description": "The last time when the replication was enabled.", "readOnly": true }, "lastModifiedDate": { "type": "string", "format": "date-time", "description": "The last time when the replication was updated.", "readOnly": true } } }, "WorkspaceReplicationState": { "type": "string", "description": "The provisioning state of the replication.", "enum": [ "Succeeded", "EnableRequested", "Enabling", "DisableRequested", "Disabling", "RollbackRequested", "RollingBack", "Failed", "Canceled" ], "x-ms-enum": { "name": "WorkspaceReplicationState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "EnableRequested", "value": "EnableRequested", "description": "EnableRequested" }, { "name": "Enabling", "value": "Enabling", "description": "Enabling" }, { "name": "DisableRequested", "value": "DisableRequested", "description": "DisableRequested" }, { "name": "Disabling", "value": "Disabling", "description": "Disabling" }, { "name": "RollbackRequested", "value": "RollbackRequested", "description": "RollbackRequested" }, { "name": "RollingBack", "value": "RollingBack", "description": "RollingBack" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Canceled", "value": "Canceled", "description": "Canceled" } ] } }, "WorkspaceSku": { "type": "object", "description": "The SKU (tier) of a workspace.", "properties": { "name": { "$ref": "#/definitions/WorkspaceSkuNameEnum", "description": "The name of the SKU." }, "capacityReservationLevel": { "type": "integer", "format": "int32", "description": "The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected.", "x-nullable": true }, "lastSkuUpdate": { "type": "string", "format": "date-time", "description": "The last time when the sku was updated.", "readOnly": true } }, "required": [ "name" ] }, "WorkspaceSkuNameEnum": { "type": "string", "description": "The name of the SKU.", "enum": [ "Free", "Standard", "Premium", "PerNode", "PerGB2018", "Standalone", "CapacityReservation", "LACluster" ], "x-ms-enum": { "name": "WorkspaceSkuNameEnum", "modelAsString": true, "values": [ { "name": "Free", "value": "Free", "description": "Free" }, { "name": "Standard", "value": "Standard", "description": "Standard" }, { "name": "Premium", "value": "Premium", "description": "Premium" }, { "name": "PerNode", "value": "PerNode", "description": "PerNode" }, { "name": "PerGB2018", "value": "PerGB2018", "description": "PerGB2018" }, { "name": "Standalone", "value": "Standalone", "description": "Standalone" }, { "name": "CapacityReservation", "value": "CapacityReservation", "description": "CapacityReservation" }, { "name": "LACluster", "value": "LACluster", "description": "LACluster" } ] } }, "keyVaultProperties": { "type": "object", "description": "The key vault properties.", "properties": { "keyVaultUri": { "type": "string", "description": "The Key Vault uri which holds they key associated with the Log Analytics cluster." }, "keyName": { "type": "string", "description": "The name of the key associated with the Log Analytics cluster." }, "keyVersion": { "type": "string", "description": "The version of the key associated with the Log Analytics cluster." }, "keyRsaSize": { "type": "integer", "format": "int32", "description": "Selected key minimum required size." } } } }, "parameters": {} }