swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector GrafanaResource API
schemes:
- https
tags:
- name: GrafanaResource
paths:
  /providers/Microsoft.Dashboard/operations:
    get:
      tags:
      - GrafanaResource
      summary: Microsoft Azure List All Available Api Operations Provided By Microsoft Dashboard
      operationId: microsoftAzureOperationsList
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK. Return all available API operations provided by Microsoft.Dashboard.
          schema:
            $ref: '#/definitions/OperationListResult'
        default:
          description: Common error response for all Azure Resource Manager APIs to return error details for failed operations.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Operations_List:
          $ref: ./examples/Operations_List.json
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/providers/Microsoft.Dashboard/grafana:
    get:
      tags:
      - GrafanaResource
      summary: Microsoft Azure List All Resources Of Workspaces For Grafana Under The Specified Subscription
      operationId: microsoftAzureGrafanaList
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK. Return all resources of workspaces for Grafana under the specified subscription.
          schema:
            $ref: '#/definitions/ManagedGrafanaListResponse'
        default:
          description: Common error response for all Azure Resource Manager APIs to return error details for failed operations.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Grafana_List:
          $ref: ./examples/Grafana_List.json
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana:
    get:
      tags:
      - GrafanaResource
      summary: Microsoft Azure List All Resources Of Workspaces For Grafana Under The Specified Resource Group
      operationId: microsoftAzureGrafanaListbyresourcegroup
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK. Return all resources of workspaces for Grafana under the given resource group.
          schema:
            $ref: '#/definitions/ManagedGrafanaListResponse'
        default:
          description: Common error response for all Azure Resource Manager APIs to return error details for failed operations.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Grafana_ListByResourceGroup:
          $ref: ./examples/Grafana_ListByResourceGroup.json
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}:
    get:
      tags:
      - GrafanaResource
      summary: Microsoft Azure Get The Properties Of A Specific Workspace For Grafana Resource
      operationId: microsoftAzureGrafanaGet
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK. Return the properties of the required workspace for Grafana resource.
          schema:
            $ref: '#/definitions/ManagedGrafana'
        default:
          description: Common error response for all Azure Resource Manager APIs to return error details for failed operations.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Grafana_Get:
          $ref: ./examples/Grafana_Get.json
      description: Needs a more full description created.
    put:
      tags:
      - GrafanaResource
      summary: Microsoft Azure Create Or Update A Workspace For Grafana Resource This Api Is Idempotent, So User Can Either Create A New Grafana Or Update An Existing Grafana
      operationId: microsoftAzureGrafanaCreate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - in: body
        name: requestBodyParameters
        required: true
        schema:
          $ref: '#/definitions/ManagedGrafana'
      responses:
        '200':
          description: OK. Successfully create a workspace for Grafana resource.
          schema:
            $ref: '#/definitions/ManagedGrafana'
        '201':
          description: Created. The operation was successfully started and will complete asynchronously.
          schema:
            $ref: '#/definitions/ManagedGrafana'
        default:
          description: Common error response for all Azure Resource Manager APIs to return error details for failed operations.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        Grafana_Create:
          $ref: ./examples/Grafana_Create.json
      description: Needs a more full description created.
    patch:
      tags:
      - GrafanaResource
      summary: Microsoft Azure Update A Workspace For Grafana Resource
      operationId: microsoftAzureGrafanaUpdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - in: body
        name: requestBodyParameters
        required: true
        schema:
          $ref: '#/definitions/ManagedGrafanaUpdateParameters'
      responses:
        '200':
          description: OK. Successfully update the workspace for Grafana resource.
          schema:
            $ref: '#/definitions/ManagedGrafana'
        default:
          description: Common error response for all Azure Resource Manager APIs to return error details for failed operations.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Grafana_Update:
          $ref: ./examples/Grafana_Update.json
      description: Needs a more full description created.
    delete:
      tags:
      - GrafanaResource
      summary: Microsoft Azure Delete A Workspace For Grafana Resource
      operationId: microsoftAzureGrafanaDelete
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK. The workspace for Grafana resource is deleted.
        '202':
          description: Accepted. The operation is accepted and will be completed asynchronously.
        '204':
          description: No Content
        default:
          description: Common error response for all Azure Resource Manager APIs to return error details for failed operations.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        Grafana_Delete:
          $ref: ./examples/Grafana_Delete.json
      description: Needs a more full description created.
definitions:
  CreatedByType:
    description: The type of identity that created the resource.
    enum:
    - User
    - Application
    - ManagedIdentity
    - Key
    type: string
    x-ms-enum:
      modelAsString: true
      name: CreatedByType
  OperationListResult:
    description: A list of REST API operations supported by Microsoft.Dashboard provider. It contains an URL link to get the next set of results.
    type: object
    properties:
      value:
        description: List of operations supported by the Microsoft.Dashboard provider.
        type: array
        x-ms-identifiers: []
        items:
          $ref: '#/definitions/OperationResult'
        readOnly: true
      nextLink:
        description: URL to get the next set of operation list results if there are any.
        type: string
        readOnly: true
  ManagedGrafana:
    type: object
    description: The grafana resource type.
    x-ms-azure-resource: true
    properties:
      id:
        description: ARM id of the grafana resource
        type: string
        readOnly: true
      name:
        description: Name of the grafana resource.
        type: string
        readOnly: true
      type:
        description: The type of the grafana resource.
        type: string
        readOnly: true
      sku:
        description: The Sku of the grafana resource.
        $ref: '#/definitions/ResourceSku'
      properties:
        description: Properties specific to the grafana resource.
        $ref: '#/definitions/ManagedGrafanaProperties'
      identity:
        description: The managed identity of the grafana resource.
        $ref: '#/definitions/ManagedIdentity'
      systemData:
        description: The system meta data relating to this grafana resource.
        $ref: '#/definitions/SystemData'
      tags:
        type: object
        additionalProperties:
          type: string
        x-ms-mutability:
        - read
        - create
        - update
        description: The tags for grafana resource.
      location:
        type: string
        x-ms-mutability:
        - read
        - create
        description: The geo-location where the grafana resource lives
  ResourceSku:
    required:
    - name
    type: object
    properties:
      name:
        type: string
  ManagedGrafanaListResponse:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/ManagedGrafana'
      nextLink:
        type: string
  ZoneRedundancy:
    enum:
    - Disabled
    - Enabled
    default: Disabled
    type: string
    x-ms-enum:
      modelAsString: true
      name: ZoneRedundancy
  AutoGeneratedDomainNameLabelScope:
    enum:
    - TenantReuse
    type: string
    x-ms-enum:
      modelAsString: true
      name: AutoGeneratedDomainNameLabelScope
    x-ms-mutability:
    - read
    - create
  Origin:
    description: The intended executor of the operation.
    enum:
    - user
    - system
    - user,system
    type: string
    readOnly: true
    x-ms-enum:
      modelAsString: true
      name: Origin
  UserAssignedIdentity:
    type: object
    properties:
      principalId:
        description: The principal id of user assigned identity.
        type: string
        readOnly: true
      clientId:
        description: The client id of user assigned identity.
        type: string
        readOnly: true
  ManagedGrafanaUpdateParameters:
    type: object
    description: The parameters for a PATCH request to a grafana resource.
    properties:
      identity:
        description: The managed identity of the grafana resource.
        $ref: '#/definitions/ManagedIdentity'
      tags:
        type: object
        description: The new tags of the grafana resource.
        additionalProperties:
          type: string
  ActionType:
    description: Indicates the action type. "Internal" refers to actions that are for internal only APIs.
    enum:
    - Internal
    type: string
    readOnly: true
    x-ms-enum:
      modelAsString: true
      name: ActionType
  ManagedGrafanaProperties:
    type: object
    description: Properties specific to the grafana resource.
    properties:
      provisioningState:
        description: Provisioning state of the resource.
        $ref: '#/definitions/ProvisioningState'
      grafanaVersion:
        description: The Grafana software version.
        type: string
        readOnly: true
      endpoint:
        description: The endpoint of the Grafana instance.
        type: string
        readOnly: true
      zoneRedundancy:
        $ref: '#/definitions/ZoneRedundancy'
      autoGeneratedDomainNameLabelScope:
        $ref: '#/definitions/AutoGeneratedDomainNameLabelScope'
  ManagedIdentityTypes:
    description: The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the resource.
    enum:
    - None
    - SystemAssigned
    type: string
    x-ms-enum:
      name: IdentityType
      modelAsString: true
  LastModifiedByType:
    enum:
    - User
    - Application
    - ManagedIdentity
    - Key
    type: string
    x-ms-enum:
      modelAsString: true
      name: LastModifiedByType
  ManagedIdentity:
    description: The managed identity of a resource.
    type: object
    properties:
      type:
        $ref: '#/definitions/ManagedIdentityTypes'
      principalId:
        description: The principal id of the system assigned identity.
        type: string
        readOnly: true
      tenantId:
        description: The tenant id of the system assigned identity.
        type: string
        readOnly: true
      userAssignedIdentities:
        description: Dictionary of user assigned identities.
        type: object
        additionalProperties:
          $ref: '#/definitions/UserAssignedIdentity'
  OperationResult:
    description: A Microsoft.Dashboard REST API operation.
    type: object
    properties:
      name:
        description: Operation name, i.e., {provider}/{resource}/{operation}.
        type: string
        readOnly: true
      isDataAction:
        description: Indicates whether the operation applies to data-plane. Set "true" for data-plane operations and "false" for ARM/control-plane operations.
        type: boolean
        readOnly: true
      display:
        $ref: '#/definitions/OperationDisplay'
      origin:
        $ref: '#/definitions/Origin'
      actionType:
        $ref: '#/definitions/ActionType'
  OperationDisplay:
    description: Localized display information for this particular operation.
    type: object
    properties:
      provider:
        description: The localized friendly form of the resource provider name, i.e., Microsoft.Dashboard.
        type: string
        readOnly: true
      resource:
        description: The localized friendly name of the resource type related to this operation, e.g., 'grafana'.
        type: string
        readOnly: true
      operation:
        description: Operation type, e.g., read, write, delete, etc.
        type: string
        readOnly: true
      description:
        description: Description of the operation, e.g., 'Read grafana'.
        type: string
        readOnly: true
  ProvisioningState:
    enum:
    - Accepted
    - Creating
    - Updating
    - Deleting
    - Succeeded
    - Failed
    - Canceled
    - Deleted
    - NotSpecified
    type: string
    x-ms-enum:
      modelAsString: true
      name: ProvisioningState
  SystemData:
    type: object
    readOnly: true
    properties:
      createdBy:
        type: string
      createdByType:
        $ref: '#/definitions/CreatedByType'
      createdAt:
        format: date-time
        type: string
      lastModifiedBy:
        type: string
      lastModifiedByType:
        $ref: '#/definitions/LastModifiedByType'
      lastModifiedAt:
        format: date-time
        type: string
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    default: 2021-09-01-preview
    description: The API version to be used with the HTTP request (e.g. YYYY-MM-DD).
    minLength: 1
  ResourceGroupNameParameter:
    name: resourceGroupName
    minLength: 1
    x-ms-parameter-location: method
    in: path
    required: true
    type: string
    description: The name of the resource group. The name is case insensitive.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    minLength: 1
    x-ms-parameter-location: client
    description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  WorkspaceNameParameter:
    in: path
    name: workspaceName
    description: The workspace name of Azure Managed Grafana.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'