SharedKeys.json

{
  "swagger": "2.0",
  "info": {
    "title": "Azure Log Analytics",
    "description": "Azure Log Analytics API reference",
    "version": "2020-08-01"
  },
  "host": "management.azure.com",
  "schemes": [
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "security": [
    {
      "azure_auth": [
        "user_impersonation"
      ]
    }
  ],
  "securityDefinitions": {
    "azure_auth": {
      "type": "oauth2",
      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
      "flow": "implicit",
      "description": "Azure Active Directory OAuth2 Flow",
      "scopes": {
        "user_impersonation": "impersonate your user account"
      }
    }
  },
  "paths": {
    "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/sharedKeys": {
      "post": {
        "tags": [
          "Workspaces"
        ],
        "x-ms-examples": {
          "SharedKeysList": {
            "$ref": "./examples/WorkspacesGetSharedKeys.json"
          }
        },
        "operationId": "SharedKeys_GetSharedKeys",
        "description": "Gets the shared keys for a workspace.",
        "parameters": [
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
          },
          {
            "$ref": "../../../common/v1/types.json#/parameters/WorkspaceNameParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "OK response definition.",
            "schema": {
              "$ref": "#/definitions/SharedKeys"
            }
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/regenerateSharedKey": {
      "post": {
        "tags": [
          "Workspaces"
        ],
        "x-ms-examples": {
          "RegenerateSharedKeys": {
            "$ref": "./examples/WorkspacesRegenerateSharedKeys.json"
          }
        },
        "operationId": "SharedKeys_Regenerate",
        "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/v1/types.json#/parameters/SubscriptionIdParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
          },
          {
            "$ref": "../../../common/v1/types.json#/parameters/WorkspaceNameParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the new shared keys associated with the Log Analytics Workspace.",
            "schema": {
              "$ref": "#/definitions/SharedKeys"
            }
          }
        }
      }
    }
  },
  "definitions": {
    "SharedKeys": {
      "properties": {
        "primarySharedKey": {
          "type": "string",
          "description": "The primary shared key of a workspace."
        },
        "secondarySharedKey": {
          "type": "string",
          "description": "The secondary shared key of a workspace."
        }
      },
      "description": "The shared keys for a workspace."
    }
  },
  "parameters": {}
}