swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector OutboundNetworkDependenciesEndpoints API
schemes:
- https
tags:
- name: OutboundNetworkDependenciesEndpoints
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints
  : get:
      tags:
      - OutboundNetworkDependenciesEndpoints
      summary: Microsoft Azure Called By Client Portal, Cli, Etc To Get A List Of All External Outbound Dependencies Fqdns Programmatically
      operationId: microsoftAzureWorkspacesListoutboundnetworkdependenciesendpoints
      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
          schema:
            $ref: '#/definitions/ExternalFQDNResponse'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        ListOutboundNetworkDependenciesEndpoints:
          $ref: ./examples/ExternalFQDN/get.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints
  : get:
      tags:
      - OutboundNetworkDependenciesEndpoints
      summary: Microsoft Azure Gets A List Of Egress Endpoints Network Endpoints Of All Outbound Dependencies In The Specified Workspace
      description: Gets the list of endpoints that VNET Injected Workspace calls Azure Databricks Control Plane. You must configure outbound access with these endpoints. For more information, see https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr
      operationId: microsoftAzureOutboundnetworkdependenciesendpointsList
      x-ms-examples:
        List OutboundNetworkDependenciesEndpoints by Workspace:
          $ref: ./examples/OutboundNetworkDependenciesEndpointsList.json
      parameters:
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/WorkspaceName'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The response contains list of outbound network dependency endpoints
          schema:
            $ref: '#/definitions/OutboundEnvironmentEndpointCollection'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
definitions:
  ErrorResponse:
    title: Error response.
    description: Contains details when the response code indicates an error.
    type: object
    properties:
      error:
        description: The error details.
        $ref: '#/definitions/ErrorInfo'
    required:
    - error
  ExternalFQDNResponse:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/FQDNEndpointsPropertyBag'
        x-ms-identifiers:
        - /properties/category
  FQDNEndpointsPropertyBag:
    description: Property bag for FQDN endpoints result
    type: object
    properties:
      properties:
        $ref: '#/definitions/FQDNEndpoints'
  ErrorInfo:
    title: The code and message for an error.
    type: object
    properties:
      code:
        description: A machine readable error code.
        type: string
      message:
        description: A human readable error message.
        type: string
      details:
        description: error details.
        type: array
        items:
          $ref: '#/definitions/ErrorDetail'
      innererror:
        description: Inner error details if they exist.
        type: string
    required:
    - code
    - message
  ErrorDetail:
    title: Error details.
    type: object
    properties:
      code:
        description: The error's code.
        type: string
      message:
        description: A human readable error message.
        type: string
      target:
        description: Indicates which property in the request is responsible for the error.
        type: string
    required:
    - code
    - message
  FQDNEndpointDetail:
    type: object
    properties:
      port:
        format: int32
        type: integer
  OutboundEnvironmentEndpointCollection:
    description: Collection of outbound network dependency endpoints
    type: array
    x-ms-identifiers: []
    items:
      $ref: '#/definitions/OutboundEnvironmentEndpoint'
  EndpointDetail:
    description: Connect information from the Workspace to a single endpoint.
    type: object
    properties:
      ipAddress:
        description: An IP Address that Domain Name currently resolves to.
        type: string
      port:
        format: int32
        description: The port an endpoint is connected to.
        type: integer
      latency:
        format: double
        description: The time in milliseconds it takes for the connection to be created from the Workspace to this IpAddress at this Port.
        type: number
      isAccessible:
        description: Whether it is possible to create a connection from the Workspace to this IpAddress at this Port.
        type: boolean
  OutboundEnvironmentEndpoint:
    description: Egress endpoints which Workspace connects to for common purposes.
    type: object
    properties:
      category:
        description: The category of endpoints accessed by the Workspace, e.g. azure-storage, azure-mysql, etc.
        type: string
      endpoints:
        description: The endpoints that Workspace connect to
        type: array
        x-ms-identifiers: []
        items:
          $ref: '#/definitions/EndpointDependency'
  EndpointDependency:
    description: A domain name or IP address the Workspace is reaching at.
    type: object
    properties:
      domainName:
        description: The domain name of the dependency.
        type: string
      endpointDetails:
        description: The Ports used when connecting to domainName.
        type: array
        x-ms-identifiers: []
        items:
          $ref: '#/definitions/EndpointDetail'
  FQDNEndpoint:
    type: object
    properties:
      domainName:
        type: string
      endpointDetails:
        type: array
        items:
          $ref: '#/definitions/FQDNEndpointDetail'
        x-ms-identifiers:
        - port
  FQDNEndpoints:
    type: object
    properties:
      category:
        type: string
      endpoints:
        type: array
        items:
          $ref: '#/definitions/FQDNEndpoint'
        x-ms-identifiers:
        - domainName
parameters:
  ResourceGroupName:
    name: resourceGroupName
    in: path
    required: true
    type: string
    description: The name of the resource group. The name is case insensitive.
    pattern: ^[-\w\._\(\)]+$
    minLength: 1
    maxLength: 90
    x-ms-parameter-location: method
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: The API version to use for this operation.
  WorkspaceName:
    name: workspaceName
    in: path
    required: true
    type: string
    description: The name of the workspace.
    minLength: 3
    maxLength: 64
    x-ms-parameter-location: method
  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}$
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: The ID of the target subscription.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'