Microsoft Azure Views API

openapi: 3.2.0
info:
  title: Microsoft Azure CustomerInsightsManagementClient Views API
  description: The Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure Customer Insights service.
  version: '2017-04-26'
  x-ms-code-generation-settings:
    name: CustomerInsightsManagementClient
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Views
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/views
  : get:
      tags:
      - Views
      operationId: microsoftAzureViewsListbyhub
      x-ms-examples:
        Views_ListByHub:
          $ref: ./examples/ViewsListByHub.json
      description: Gets all available views for given user in the specified hub.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: hubName
        in: path
        required: true
        description: The name of the hub.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: userId
        in: query
        required: true
        description: The user ID. Use * to retrieve hub level views.
        schema:
          type: string
      responses:
        '200':
          description: OK. Successfully get all the views in the hub for the given user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ViewListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/views/{viewName}
  : put:
      tags:
      - Views
      operationId: microsoftAzureViewsCreateorupdate
      x-ms-examples:
        Views_CreateOrUpdate:
          $ref: ./examples/ViewsCreateOrUpdate.json
      description: Creates a view or updates an existing view in the hub.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: hubName
        in: path
        required: true
        description: The name of the hub.
        schema:
          type: string
      - name: viewName
        in: path
        required: true
        description: The name of the view.
        schema:
          type: string
          maxLength: 512
          minLength: 1
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. Successfully created the view.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ViewResourceFormat'
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ViewResourceFormat'
        description: Parameters supplied to the CreateOrUpdate View operation.
        required: true
    get:
      tags:
      - Views
      operationId: microsoftAzureViewsGet
      x-ms-examples:
        Views_Get:
          $ref: ./examples/ViewsGet.json
      description: Gets a view in the hub.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: hubName
        in: path
        required: true
        description: The name of the hub.
        schema:
          type: string
      - name: viewName
        in: path
        required: true
        description: The name of the view.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: userId
        in: query
        required: true
        description: The user ID. Use * to retrieve hub level view.
        schema:
          type: string
      responses:
        '200':
          description: OK. Successfully get the view.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ViewResourceFormat'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    delete:
      tags:
      - Views
      operationId: microsoftAzureViewsDelete
      x-ms-examples:
        Views_Delete:
          $ref: ./examples/ViewsDelete.json
      description: Deletes a view in the specified hub.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: hubName
        in: path
        required: true
        description: The name of the hub.
        schema:
          type: string
      - name: viewName
        in: path
        required: true
        description: The name of the view.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: userId
        in: query
        required: true
        description: The user ID. Use * to retrieve hub level view.
        schema:
          type: string
      responses:
        '200':
          description: OK. The view is deleted.
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
components:
  schemas:
    ProxyResource:
      properties:
        id:
          readOnly: true
          type: string
          description: Resource ID.
        name:
          readOnly: true
          type: string
          description: Resource name.
        type:
          readOnly: true
          type: string
          description: Resource type.
      x-ms-azure-resource: true
      description: Common properties of proxy resource.
    View:
      required:
      - definition
      properties:
        viewName:
          type: string
          readOnly: true
          description: Name of the view.
        userId:
          type: string
          description: the user ID.
        tenantId:
          type: string
          readOnly: true
          description: the hub name.
        displayName:
          type: object
          additionalProperties:
            type: string
          description: Localized display name for the view.
        definition:
          type: string
          description: View definition.
        changed:
          type: string
          readOnly: true
          format: date-time
          description: Date time when view was last modified.
        created:
          type: string
          readOnly: true
          format: date-time
          description: Date time when view was created.
      description: The view in Customer 360 web application.
    ViewListResult:
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/ViewResourceFormat'
          description: Results of the list operation.
        nextLink:
          type: string
          description: Link to the next set of results.
      description: The response of list view operation.
    ViewResourceFormat:
      description: The view resource format.
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/View'
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Client Api Version.
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.