swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Endpoint API
schemes:
- https
tags:
- name: Endpoint
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/deployments
  : get:
      tags:
      - Endpoint
      summary: Microsoft Azure Get All The Deployments Under The Workspace Scope
      operationId: microsoftAzureEndpointdeploymentGetinworkspace
      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
      - $ref: '#/parameters/EndpointTypeParameter'
      - $ref: '#/parameters/PaginationParameter'
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/EndpointDeploymentResourcePropertiesBasicResourceArmPaginatedResult'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get Endpoint Deployments In Workspace:
          $ref: ./examples/Endpoint/Deployment/getInWorkspace.json
      x-ms-pageable:
        nextLinkName: nextLink
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints
  : get:
      tags:
      - Endpoint
      summary: Microsoft Azure List All The Endpoints Under This Workspace
      operationId: microsoftAzureEndpointList
      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
      - $ref: '#/parameters/EndpointTypeParameter'
      - $ref: '#/parameters/PaginationParameter'
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/EndpointResourcePropertiesBasicResourceArmPaginatedResult'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List Endpoint:
          $ref: ./examples/Endpoint/list.json
      x-ms-pageable:
        nextLinkName: nextLink
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{endpointName}
  : get:
      tags:
      - Endpoint
      summary: Microsoft Azure Gets Endpoint Resource
      operationId: microsoftAzureEndpointGet
      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: '#/parameters/EndpointNameParameter'
      - $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/EndpointResourcePropertiesBasicResource'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get Endpoint:
          $ref: ./examples/Endpoint/get.json
      description: Needs a more full description created.
    put:
      tags:
      - Endpoint
      summary: Microsoft Azure Create Or Update Endpoint Resource With The Specified Parameters
      operationId: microsoftAzureEndpointCreateorupdate
      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: '#/parameters/EndpointNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - in: body
        name: body
        description: Endpoint resource object
        required: true
        schema:
          $ref: '#/definitions/EndpointResourcePropertiesBasicResource'
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/EndpointResourcePropertiesBasicResource'
        '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:
        Create Endpoint:
          $ref: ./examples/Endpoint/create.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}/endpoints/{endpointName}/deployments
  : get:
      tags:
      - Endpoint
      summary: Microsoft Azure Get All The Deployments Under The Endpoint Resource Scope
      operationId: microsoftAzureEndpointdeploymentList
      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: '#/parameters/EndpointNameParameter'
      - $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/EndpointDeploymentResourcePropertiesBasicResourceArmPaginatedResult'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get Endpoint Deployments:
          $ref: ./examples/Endpoint/Deployment/getDeployments.json
      x-ms-pageable:
        nextLinkName: nextLink
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{endpointName}/deployments/{deploymentName}
  : delete:
      tags:
      - Endpoint
      summary: Microsoft Azure Delete Endpoint Deployment Resource By Name
      operationId: microsoftAzureEndpointdeploymentDelete
      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: '#/parameters/EndpointNameParameter'
      - $ref: '#/parameters/DeploymentNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '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
        '204':
          description: Deployment was successfully deleted or doesn't exist.
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Delete Endpoint Deployment:
          $ref: ./examples/Endpoint/Deployment/delete.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      description: Needs a more full description created.
    get:
      tags:
      - Endpoint
      summary: Microsoft Azure Get Deployments Under Endpoint Resource By Name
      operationId: microsoftAzureEndpointdeploymentGet
      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: '#/parameters/EndpointNameParameter'
      - $ref: '#/parameters/DeploymentNameParameter'
      - $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/EndpointDeploymentResourcePropertiesBasicResource'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get Endpoint Deployment:
          $ref: ./examples/Endpoint/Deployment/get.json
      description: Needs a more full description created.
    put:
      tags:
      - Endpoint
      summary: Microsoft Azure Create Or Update Endpoint Deployment Resource With The Specified Parameters
      operationId: microsoftAzureEndpointdeploymentCreateorupdate
      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: '#/parameters/EndpointNameParameter'
      - $ref: '#/parameters/DeploymentNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - in: body
        name: body
        description: deployment object
        required: true
        schema:
          $ref: '#/definitions/EndpointDeploymentResourcePropertiesBasicResource'
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/EndpointDeploymentResourcePropertiesBasicResource'
        '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:
        Create Endpoint Deployment:
          $ref: ./examples/Endpoint/Deployment/create.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}/endpoints/{endpointName}/listKeys
  : post:
      tags:
      - Endpoint
      summary: Microsoft Azure List Keys For The Endpoint Resource
      operationId: microsoftAzureEndpointListkeys
      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: '#/parameters/EndpointNameParameter'
      - $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/EndpointKeys'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List Endpoint Keys:
          $ref: ./examples/Endpoint/listKeys.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{endpointName}/models
  : get:
      tags:
      - Endpoint
      summary: Microsoft Azure Get Available Models Under The Endpoint Resource
      operationId: microsoftAzureEndpointGetmodels
      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: '#/parameters/EndpointNameParameter'
      - $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/EndpointModels'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get Endpoint Models:
          $ref: ./examples/Endpoint/getModels.json
      x-ms-pageable:
        nextLinkName: nextLink
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{endpointName}/regenerateKey
  : post:
      tags:
      - Endpoint
      summary: Microsoft Azure Regenerate Account Keys
      operationId: microsoftAzureEndpointRegeneratekeys
      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: '#/parameters/EndpointNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/RegenerateServiceAccountKeyContent'
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/AccountApiKeys'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Regenerate Endpoint Keys:
          $ref: ./examples/Endpoint/regenerateKey.json
      description: Needs a more full description created.
  /endpoints:
    get:
      tags:
      - Endpoint
      description: Gets a list of endpoints for the authenticated Speech service resource.
      operationId: microsoftAzureEndpointsList
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/QuerySkip'
      - $ref: '#/parameters/QueryMaxPageSize'
      - $ref: '#/parameters/QueryFilter'
      - $ref: '#/parameters/QueryApiVersion'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PaginatedEndpoints'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      x-ms-examples:
        Get all endpoints:
          $ref: ./examples/get_endpoints.json
      summary: Microsoft Azure Get Endpoints
  /endpoints/{id}:
    get:
      tags:
      - Endpoint
      description: Gets the endpoint identified by the given ID.
      operationId: microsoftAzureEndpointsGet
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/PathUuid'
      - $ref: '#/parameters/QueryApiVersion'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Endpoint'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Get an endpoint:
          $ref: ./examples/get_endpoint.json
      summary: Microsoft Azure Get Endpoints Id
    delete:
      tags:
      - Endpoint
      description: Deletes the endpoint identified by the given ID.
      operationId: microsoftAzureEndpointsDelete
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/PathUuid'
      - $ref: '#/parameters/QueryApiVersion'
      responses:
        '204':
          description: No Content
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Delete an endpoint:
          $ref: ./examples/delete_endpoint.json
      summary: Microsoft Azure Delete Endpoints Id
    put:
      tags:
      - Endpoint
      description: Creates a new endpoint.
      operationId: microsoftAzureEndpointsCreate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/HeaderOperationId'
      - $ref: '#/parameters/PathUuid'
      - $ref: '#/parameters/QueryApiVersion'
      - in: body
        name: endpoint
        description: Endpoint definition
        required: true
        schema:
          $ref: '#/definitions/Endpoint'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Endpoint'
          headers:
            Operation-Id:
              type: string
              description: ID of the operation.
            Operation-Location:
              description: The location of the operation job. Use this URL to monitor operation status.
              type: string
              format: uri
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-examples:
        Create an endpoint:
          $ref: ./examples/create_endpoint.json
      summary: Microsoft Azure Put Endpoints Id
  /endpoints/{id}:resume:
    post:
      tags:
      - Endpoint
      description: Resumes the endpoint identified by the given ID.
      operationId: microsoftAzureEndpointsResume
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/HeaderOperationId'
      - $ref: '#/parameters/PathUuid'
      - $ref: '#/parameters/QueryApiVersion'
      responses:
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/Endpoint'
          headers:
            Operation-Id:
              type: string
              description: ID of the operation.
            Operation-Location:
              description: The location of the operation job. Use this URL to monitor operation status.
              type: string
              format: uri
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: operation-location
      x-ms-examples:
        Resume an endpoint:
          $ref: ./examples/resume_endpoint.json
      summary: Microsoft Azure Post Endpoints Id:resume
  /endpoints/{id}:suspend:
    post:
      tags:
      - Endpoint
      description: Suspends the endpoint identified by the given ID.
      operationId: microsoftAzureEndpointsSuspend
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/HeaderOperationId'
      - $ref: '#/parameters/PathUuid'
      - $ref: '#/parameters/QueryApiVersion'
      responses:
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/Endpoint'
          headers:
            Operation-Id:
              type: string
              description: ID of the operation.
            Operation-Location:
              description: The location of the operation job. Use this URL to monitor operation status.
              type: string
              format: uri
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: operation-location
      x-ms-examples:
        Suspend an endpoint:
          $ref: ./examples/suspend_endpoint.json
      summary: Microsoft Azure Post Endpoints Id:suspend
definitions:
  ModelDeprecationInfo:
    description: Cognitive Services account ModelDeprecationInfo.
    type: object
    properties:
      fineTune:
        type: string
        description: The datetime of deprecation of the fineTune Model.
      inference:
        type: string
        description: The datetime of deprecation of the inference Model.
  PaginatedEndpoints:
    description: Paginated endpoint list
    required:
    - value
    type: object
    properties:
      value:
        description: Endpoint list
        type: array
        items:
          $ref: '#/definitions/Endpoint'
      nextLink:
        description: Link to next page.
        format: uri
        type: string
  EndpointResourcePropertiesBasicResource:
    required:
    - properties
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/Resource
    properties:
      properties:
        $ref: '#/definitions/EndpointResourceProperties'
  EndpointModels:
    type: object
    properties:
      nextLink:
        description: The link to the next page constructed using the continuationToken.  If null, there are no additional pages.
        type: string
      value:
        description: List of models.
        type: array
        items:
          $ref: '#/definitions/AccountModel'
  EndpointKeys:
    type: object
    properties:
      keys:
        description: Dictionary of Keys for the endpoint.
        $ref: '#/definitions/AccountApiKeys'
        x-ms-secret: true
  AccountApiKeys:
    type: object
    properties:
      key1:
        type: string
        x-ms-secret: true
      key2:
        type: string
        x-ms-secret: true
  AccountModel:
    description: Cognitive Services account Model.
    type: object
    properties:
      baseModel:
        type: object
        description: Base Model Identifier.
        $ref: '#/definitions/DeploymentModel'
      isDefaultVersion:
        type: boolean
        description: If the model is default version.
      skus:
        type: array
        items:
          $ref: '#/definitions/ModelSku'
        x-ms-identifiers:
        - name
        description: The list of Model Sku.
      maxCapacity:
        type: integer
        format: int32
        description: The max capacity.
      capabilities:
        type: object
        additionalProperties:
          type: string
        description: The capabilities.
      finetuneCapabilities:
        type: object
        additionalProperties:
          type: string
        description: The capabilities for finetune models.
      deprecation:
        type: object
        $ref: '#/definitions/ModelDeprecationInfo'
      lifecycleStatus:
        type: string
        enum:
        - GenerallyAvailable
        - Preview
        x-ms-enum:
          name: ModelLifecycleStatus
          modelAsString: true
        description: Model lifecycle status.
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
    allOf:
    - $ref: '#/definitions/DeploymentModel'
  CapacityConfig:
    type: object
    properties:
      minimum:
        type: integer
        format: int32
        description: The minimum capacity.
      maximum:
        type: integer
        format: int32
        description: The maximum capacity.
      step:
        type: integer
        format: int32
        description: The minimal incremental between allowed values for capacity.
      default:
        type: integer
        format: int32
        description: The default capacity.
      allowedValues:
        type: array
        items:
          type: integer
          format: int32
        description: The array of allowed values for capacity.
    description: The capacity configuration.
  EndpointDeploymentResourcePropertiesBasicResourceArmPaginatedResult:
    type: object
    properties:
      nextLink:
        type: string
      value:
        type: array
        items:
          $ref: '#/definitions/EndpointDeploymentResourcePropertiesBasicResource'
  DefaultResourceProvisioningState:
    enum:
    - NotStarted
    - Failed
    - Creating
    - Updating
    - Succeeded
    - Deleting
    - Canceled
    type: string
    readOnly: true
    x-ms-mutability:
    - read
    x-ms-enum:
      name: DefaultResourceProvisioningState
      modelAsString: true
  ThrottlingRule:
    type: object
    properties:
      key:
        type: string
      renewalPeriod:
        type: number
      count:
        type: number
      minCount:
        type: number
      dynamicThrottlingEnabled:
        type: boolean
      matchPatterns:
        type: array
        items:
          $ref: '#/definitions/RequestMatchPattern'
        x-ms-identifiers:
        - path
        - method
  EndpointProperties:
    description: Endpoint properties
    type: object
    properties:
      kind:
        $ref: '#/definitions/EndpointKind'
  CallRateLimit:
    type: object
    properties:
      count:
        type: number
        description: The count value of Call Rate Limit.
      renewalPeriod:
        type: number
        description: The renewal period in seconds of Call Rate Limit.
      rules:
        type: array
        items:
          $ref: '#/definitions/ThrottlingRule'
        x-ms-identifiers:
        - key
    description: The call rate limit Cognitive Services account.
  EndpointDeploymentResourceProperties:
    required:
    - type
    type: object
    properties:
      failureReason:
        description: The failure reason if the creation failed.
        type: string
      provisioningState:
        description: Read-only provision state status property.
        $ref: '#/definitions/DefaultResourceProvisioningState'
      type:
        description: Kind of the deployment.
        minLength: 1
        pattern: '[a-zA-Z0-9._]'
        type: string
    discriminator: type
  DeploymentModel:
    type: object
    properties:
      format:
        type: string
        description: Deployment model format.
      name:
        type: string
        description: Deployment model name.
      version:
        type: string
        description: Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API.
      source:
        type: string
        description: Optional. Deployment model source ARM resource ID.
      callRateLimit:
        readOnly: true
        $ref: '#/definitions/CallRateLimit'
    description: Properties of Cognitive Services account deployment model.
  ModelSku:
    type: object
    properties:
      name:
        type: string
        description: The name of the model SKU.
      usageName:
        type: string
        description: The usage name of the model SKU.
      deprecationDate:
        type: string
        format: date-time
        description: The datetime of deprecation of the model SKU.
      capacity:
        type: object
        description: The capacity configuration.
        $ref: '#/definitions/CapacityConfig'
      rateLimits:
        type: array
        items:
          $ref: '#/definitions/CallRateLimit'
        x-ms-identifiers: []
        description: The list of rateLimit.
    description: Describes an available Cognitive Services Model SKU.
  EndpointResourcePropertiesBasicResourceArmPaginatedResult:
    type: object
    properties:
      nextLink:
        type: string
      value:
        type: array
        items:
          $ref: '#/definitions/EndpointResourcePropertiesBasicResource'
  ResourceId:
    description: Resource id
    type: string
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
    minLength: 3
    maxLength: 64
  EndpointResourceProperties:
    required:
    - endpointType
    type: object
    properties:
      associatedResourceId:
        description: Byo resource id for creating the built-in model service endpoints.
        type: string
        format: arm-id
      endpointType:
        description: Type of the endpoint.
        type: string
        enum:
        - Azure.OpenAI
        - Azure.Speech
        - Azure.ContentSafety
        - Azure.Llama
        - managedOnlineEndpoint
        x-ms-enum:
          name: endpointType
          modelAsString: true
      endpointUri:
        description: Uri of the endpoint.
        type: string
        format: url
      failureReason:
        description: The failure reason if the creation failed.
        type: string
      name:
        description: Name of the endpoint.
        type: string
      provisioningState:
        description: Read-only provision state status property.
        $ref: '#/definitions/DefaultResourceProvisioningState'
    discriminator: endpointType
  Status:
    description: Status of a resource.
    enum:
    - NotStarted
    - Running
    - Succeeded
    - Failed
    - Disabling
    - Disabled
    type: string
    x-ms-enum:
      name: Status
      modelAsString: true
  EndpointDeploymentResourcePropertiesBasicResource:
    required:
    - properties
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/Resource
    properties:
      properties:
        $ref: '#/definitions/EndpointDeploymentResourceProperties'
  ServiceAccountKeyName:
    enum:
    - Key1
    - Key2
    type: string
    x-ms-enum:
      name: ServiceAccountKeyName
      modelAsString: true
  Error:
    description: Top-level error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains an top-level error with error code, message, details, target and an inner error with more descriptive details.
    required:
    - code
    - message
    type: object
    properties:
      code:
        $ref: '#/definitions/ErrorCode'
      target:
        description: The source of the error. For example it would be "model" or "model id" in case of invalid model.
        type: string
      message:
        description: Top-level error message.
        type: string
      details:
        description: Additional supportive details regarding the error and/or expected policies.
        type: array
        items:
          $ref: '#/definitions/Error'
      innererror:
        $ref: '#/definitions/InnerError'
  RequestMatchPattern:
    type: object
    properties:
      path:
        type: string
      method:
        type: string
  ErrorResponse:
    description: Error response follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/Error'
  ErrorCode:
    description: Top-level error code
    enum:
    - BadRequest
    - BadArgument
    - Unauthorized
    - Forbidden
    - NotFound
    - UnsupportedMediaType
    - TooManyRequests
    - InternalServerError
    - ServiceUnavailable
    type: string
    x-ms-enum:
      name: ErrorCode
      modelAsString: true
  RegenerateServiceAccountKeyContent:
    type: object
    properties:
      keyName:
        $ref: '#/definitions/ServiceAccountKeyName'
  EndpointKind:
    description: Endpoint kind
    enum:
    - HighPerformance
    - FastResume
    type: string
    x-ms-enum:
      name: EndpointKind
      modelAsString: true
  Endpoint:
    description: Endpoint object
    required:
    - projectId
    - modelId
    type: object
    properties:
      id:
        description: Endpoint Id
        type: string
        format: uuid
      displayName:
        description: Endpoint name
        minLength: 1
        type: string
      description:
        description: Endpoint description
        type: string
      projectId:
        $ref: '#/definitions/ResourceId'
      modelId:
        $ref: '#/definitions/ResourceId'
      properties:
        $ref: '#/definitions/EndpointProperties'
      status:
        $ref: '#/definitions/Status'
      createdDateTime:
        description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
        format: date-time
        type: string
        readOnly: true
      lastActionDateTime:
        description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
        format: date-time
        type: string
        readOnly: true
  InnerError:
    description: Inner error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains required properties error code, message and optional properties target, inner error(this can be nested).
    type: object
    properties:
      code:
        description: Detailed error code to help diagnostic.
        type: string
      target:
        description: The source of the error. For example it would be "model" or "model id" in case of invalid model.
        type: string
      message:
        description: Detailed error message.
        type: string
      innererror:
        $ref: '#/definitions/InnerError'
parameters:
  QueryMaxPageSize:
    name: maxpagesize
    in: query
    description: The maximum number of items to include in a single response.
    required: false
    type: integer
    format: int32
    default: 100
    x-ms-parameter-location: method
  PaginationParameter:
    in: query
    name: $skip
    description: Continuation token for pagination.
    type: string
    x-ms-parameter-location: method
  PathUuid:
    name: id
    in: path
    description: The resource ID, which should be UUID.
    required: true
    type: string
    format: uuid
    x-ms-parameter-location: method
  EndpointNameParameter:
    in: path
    name: endpointName
    description: Name of the endpoint resource.
    required: true
    type: string
    x-ms-parameter-location: method
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]{2,32}$
  HeaderOperationId:
    name: Operation-Id
    in: header
    description: ID of the status monitor for the operation. If the Operation-Id header matches an existing operation and the request is not identical to the prior request, it will fail with a 400 Bad Request.
    required: false
    type: string
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
    minLength: 3
    maxLength: 64
    x-ms-parameter-location: method
  QueryFilter:
    name: filter
    in: query
    description: "Filter condition.\r\n  - **Supported properties:** projectId, createdDateTime, locale, kind\r\n  - **Operators:**\r\n    - eq, ne are supported for all properties.\r\n    - gt, ge, lt, le are supported for createdDateTime.\r\n  - **Example:**\r\n    - ```filter=projectId eq 'Jessica'``` (filter by project ID)\r\n    - ```filter=kind eq 'ProfessionalVoice'``` (filter project by kind)\r\n    - ```filter=locale eq 'en-US'``` (filter training set and model by locale)\r\n    - ```filter=createdDateTime gt 2022-12-30T23:59:59.99Z``` (filter resource created time after 2023-11-01)"
    required: false
    type: string
    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}$
  DeploymentNameParameter:
    in: path
    name: deploymentName
    description: Name of the deployment resource
    required: true
    type: string
    x-ms-parameter-location: method
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$
  QueryApiVersion:
    name: api-version
    in: query
    description: The API version to use for this operation.
    required: true
    type: string
    minLength: 1
    x-ms-parameter-location: method
    x-ms-client-name: apiVersion
  QuerySkip:
    name: skip
    in: query
    description: The number of result items to skip.
    required: false
    type: integer
    format: int32
    default: 0
    x-ms-parameter-location: method
  EndpointTypeParameter:
    in: query
    name: endpointType
    description: Endpoint type filter
    type: string
    enum:
    - Azure.OpenAI
    - Azure.Speech
    - Azure.ContentSafety
    - Azure.Llama
    - managedOnlineEndpoint
    x-ms-enum:
      name: endpointType
      modelAsString: true
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'