swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ProxyOperations API
schemes:
- https
tags:
- name: ProxyOperations
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/diagnose
  : post:
      tags:
      - ProxyOperations
      summary: Microsoft Azure Diagnose Workspace Setup Issue
      operationId: microsoftAzureWorkspacesDiagnose
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - in: body
        name: body
        description: The parameter of diagnosing workspace health
        schema:
          $ref: '#/definitions/DiagnoseWorkspaceParameters'
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/DiagnoseResponseResult'
        '202':
          description: Accepted
          headers:
            Location:
              description: URI to poll for asynchronous operation result.
              type: string
            Retry-After:
              description: Duration the client should wait between requests, in seconds.
              type: integer
              format: int32
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Diagnose Workspace:
          $ref: ./examples/Workspace/diagnose.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys
  : post:
      tags:
      - ProxyOperations
      summary: Microsoft Azure Lists All The Keys Associated With This Workspace This Includes Keys For The Storage Account, App Insights And Password For Container Registry
      operationId: microsoftAzureWorkspacesListkeys
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/ListWorkspaceKeysResult'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List Workspace Keys:
          $ref: ./examples/Workspace/listKeys.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookAccessToken
  : post:
      tags:
      - ProxyOperations
      summary: Microsoft Azure Get Azure Machine Learning Workspace Notebook Access Token
      operationId: microsoftAzureWorkspacesListnotebookaccesstoken
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/NotebookAccessTokenResult'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List Workspace Keys:
          $ref: ./examples/Workspace/listNotebookAccessToken.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookKeys
  : post:
      tags:
      - ProxyOperations
      summary: Microsoft Azure Lists Keys Of Azure Machine Learning Workspaces Notebook
      operationId: microsoftAzureWorkspacesListnotebookkeys
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/ListNotebookKeysResult'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List Workspace Keys:
          $ref: ./examples/Notebook/listKeys.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listStorageAccountKeys
  : post:
      tags:
      - ProxyOperations
      summary: Microsoft Azure Lists Keys Of Azure Machine Learning Workspace S Storage Account
      operationId: microsoftAzureWorkspacesListstorageaccountkeys
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/ListStorageAccountKeysResult'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List Workspace Keys:
          $ref: ./examples/Workspace/listStorageAccountKeys.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/prepareNotebook
  : post:
      tags:
      - ProxyOperations
      summary: Microsoft Azure Prepare Azure Machine Learning Workspace S Notebook Resource
      operationId: microsoftAzureWorkspacesPreparenotebook
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/NotebookResourceInfo'
        '202':
          description: Accepted
          headers:
            Location:
              description: URI to poll for asynchronous operation result.
              type: string
            Retry-After:
              description: Duration the client should wait between requests, in seconds.
              type: integer
              format: int32
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Prepare Notebook:
          $ref: ./examples/Notebook/prepare.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/resyncKeys
  : post:
      tags:
      - ProxyOperations
      summary: Microsoft Azure Resync All The Keys Associated With This Workspace This Includes Keys For The Storage Account, App Insights And Password For Container Registry
      operationId: microsoftAzureWorkspacesResynckeys
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
        '202':
          description: Accepted
          headers:
            Location:
              description: URI to poll for asynchronous operation result.
              type: string
            Retry-After:
              description: Duration the client should wait between requests, in seconds.
              type: integer
              format: int32
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Resync Workspace Keys:
          $ref: ./examples/Workspace/resyncKeys.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      description: Needs a more full description created.
definitions:
  DiagnoseWorkspaceParameters:
    description: Parameters to diagnose a workspace
    type: object
    properties:
      value:
        $ref: '#/definitions/DiagnoseRequestProperties'
  NotebookAccessTokenResult:
    type: object
    properties:
      accessToken:
        type: string
        readOnly: true
        x-ms-mutability:
        - read
        x-ms-secret: true
      expiresIn:
        format: int32
        type: integer
        readOnly: true
        x-ms-mutability:
        - read
      hostName:
        type: string
        readOnly: true
        x-ms-mutability:
        - read
      notebookResourceId:
        type: string
        readOnly: true
        x-ms-mutability:
        - read
      publicDns:
        type: string
        readOnly: true
        x-ms-mutability:
        - read
      refreshToken:
        type: string
        readOnly: true
        x-ms-mutability:
        - read
        x-ms-secret: true
      scope:
        type: string
        readOnly: true
        x-ms-mutability:
        - read
      tokenType:
        type: string
        readOnly: true
        x-ms-mutability:
        - read
  Password:
    type: object
    properties:
      name:
        type: string
        readOnly: true
        x-ms-mutability:
        - read
        x-ms-secret: true
      value:
        type: string
        readOnly: true
        x-ms-mutability:
        - read
        x-ms-secret: true
  NotebookPreparationError:
    type: object
    properties:
      errorMessage:
        type: string
      statusCode:
        format: int32
        type: integer
  RegistryListCredentialsResult:
    type: object
    properties:
      location:
        description: The location of the workspace ACR
        type: string
        readOnly: true
        x-ms-mutability:
        - read
      passwords:
        type: array
        items:
          $ref: '#/definitions/Password'
        x-ms-identifiers:
        - name
      username:
        description: The username of the workspace ACR
        type: string
        readOnly: true
        x-ms-mutability:
        - read
  ListWorkspaceKeysResult:
    type: object
    properties:
      appInsightsInstrumentationKey:
        description: The access key of the workspace app insights
        type: string
        readOnly: true
        x-ms-mutability:
        - read
        x-ms-secret: true
      containerRegistryCredentials:
        $ref: '#/definitions/RegistryListCredentialsResult'
      notebookAccessKeys:
        $ref: '#/definitions/ListNotebookKeysResult'
      userStorageArmId:
        description: The arm Id key of the workspace storage
        type: string
        readOnly: true
        x-ms-mutability:
        - read
      userStorageKey:
        description: The access key of the workspace storage
        type: string
        readOnly: true
        x-ms-mutability:
        - read
        x-ms-secret: true
  NotebookResourceInfo:
    type: object
    properties:
      fqdn:
        type: string
      isPrivateLinkEnabled:
        type: boolean
      notebookPreparationError:
        description: The error that occurs when preparing notebook.
        $ref: '#/definitions/NotebookPreparationError'
      resourceId:
        description: the data plane resourceId that used to initialize notebook component
        type: string
  ListStorageAccountKeysResult:
    type: object
    properties:
      userStorageKey:
        description: The access key of the storage
        type: string
        readOnly: true
        x-ms-mutability:
        - read
        x-ms-secret: true
  DiagnoseResultLevel:
    description: Level of workspace setup error
    enum:
    - Warning
    - Error
    - Information
    type: string
    x-ms-enum:
      name: DiagnoseResultLevel
      modelAsString: true
  DiagnoseRequestProperties:
    type: object
    properties:
      applicationInsights:
        description: Setting for diagnosing dependent application insights
        type: object
        additionalProperties: {}
      containerRegistry:
        description: Setting for diagnosing dependent container registry
        type: object
        additionalProperties: {}
      dnsResolution:
        description: Setting for diagnosing dns resolution
        type: object
        additionalProperties: {}
      keyVault:
        description: Setting for diagnosing dependent key vault
        type: object
        additionalProperties: {}
      nsg:
        description: Setting for diagnosing network security group
        type: object
        additionalProperties: {}
      others:
        description: Setting for diagnosing unclassified category of problems
        type: object
        additionalProperties: {}
      requiredResourceProviders:
        description: Setting for diagnosing the presence of required resource providers in the workspace.
        type: object
        additionalProperties: {}
      resourceLock:
        description: Setting for diagnosing resource lock
        type: object
        additionalProperties: {}
      storageAccount:
        description: Setting for diagnosing dependent storage account
        type: object
        additionalProperties: {}
      udr:
        description: Setting for diagnosing user defined routing
        type: object
        additionalProperties: {}
  DiagnoseResponseResult:
    type: object
    properties:
      value:
        type: object
        properties:
          userDefinedRouteResults:
            type: array
            items:
              $ref: '#/definitions/DiagnoseResult'
            x-ms-identifiers:
            - message
          networkSecurityRuleResults:
            type: array
            items:
              $ref: '#/definitions/DiagnoseResult'
            x-ms-identifiers:
            - message
          resourceLockResults:
            type: array
            items:
              $ref: '#/definitions/DiagnoseResult'
            x-ms-identifiers:
            - message
          dnsResolutionResults:
            type: array
            items:
              $ref: '#/definitions/DiagnoseResult'
            x-ms-identifiers:
            - message
          storageAccountResults:
            type: array
            items:
              $ref: '#/definitions/DiagnoseResult'
            x-ms-identifiers:
            - message
          keyVaultResults:
            type: array
            items:
              $ref: '#/definitions/DiagnoseResult'
            x-ms-identifiers:
            - message
          containerRegistryResults:
            type: array
            items:
              $ref: '#/definitions/DiagnoseResult'
            x-ms-identifiers:
            - message
          applicationInsightsResults:
            type: array
            items:
              $ref: '#/definitions/DiagnoseResult'
            x-ms-identifiers:
            - message
          otherResults:
            type: array
            items:
              $ref: '#/definitions/DiagnoseResult'
            x-ms-identifiers:
            - message
  DiagnoseResult:
    description: Result of Diagnose
    type: object
    properties:
      code:
        description: Code for workspace setup error
        type: string
        readOnly: true
        x-ms-mutability:
        - read
      level:
        description: Level of workspace setup error
        $ref: '#/definitions/DiagnoseResultLevel'
        readOnly: true
        x-ms-mutability:
        - read
      message:
        description: Message of workspace setup error
        type: string
        readOnly: true
        x-ms-mutability:
        - read
  ListNotebookKeysResult:
    type: object
    properties:
      primaryAccessKey:
        description: The primary access key of the Notebook
        type: string
        readOnly: true
        x-ms-mutability:
        - read
        x-ms-secret: true
      secondaryAccessKey:
        description: The secondary access key of the Notebook
        type: string
        readOnly: true
        x-ms-mutability:
        - read
        x-ms-secret: true
parameters:
  WorkspaceNameParameter:
    in: path
    name: workspaceName
    description: Azure Machine Learning Workspace Name
    required: true
    type: string
    x-ms-parameter-location: method
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'