Microsoft Azure ComputePolicies API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ComputePolicies API
schemes:
- https
tags:
- name: ComputePolicies
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/computePolicies
  : get:
      tags:
      - ComputePolicies
      operationId: microsoftAzureComputepoliciesListbyaccount
      description: Lists the Data Lake Analytics compute policies within the specified Data Lake Analytics account. An account supports, at most, 50 policies
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully listed the compute policies.
          schema:
            $ref: '#/definitions/ComputePolicyListResult'
        default:
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
          description: ''
      x-ms-examples:
        Lists the compute policies within the adla account:
          $ref: ./examples/ComputePolicies_ListByAccount.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datalakeanalytics Accounts Accountname Computepolicies
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/computePolicies/{computePolicyName}
  : put:
      tags:
      - ComputePolicies
      operationId: microsoftAzureComputepoliciesCreateorupdate
      description: Creates or updates the specified compute policy. During update, the compute policy with the specified name will be replaced with this new compute policy. An account supports, at most, 50 policies
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - name: computePolicyName
        in: path
        required: true
        type: string
        description: The name of the compute policy to create or update.
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateOrUpdateComputePolicyParameters'
        description: Parameters supplied to create or update the compute policy. The max degree of parallelism per job property, min priority per job property, or both must be present.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully created or updated the specified compute policy
          schema:
            $ref: '#/definitions/ComputePolicy'
        default:
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
          description: ''
      x-ms-examples:
        Creates or updates the specified compute policy:
          $ref: ./examples/ComputePolicies_CreateOrUpdate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datalakeanalytics Accounts Accountname Computepolicies Computepolicyname
    get:
      tags:
      - ComputePolicies
      operationId: microsoftAzureComputepoliciesGet
      description: Gets the specified Data Lake Analytics compute policy.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - name: computePolicyName
        in: path
        required: true
        type: string
        description: The name of the compute policy to retrieve.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the specified compute policy.
          schema:
            $ref: '#/definitions/ComputePolicy'
        default:
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
          description: ''
      x-ms-examples:
        Gets the specified compute policy:
          $ref: ./examples/ComputePolicies_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datalakeanalytics Accounts Accountname Computepolicies Computepolicyname
    patch:
      tags:
      - ComputePolicies
      operationId: microsoftAzureComputepoliciesUpdate
      description: Updates the specified compute policy.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - name: computePolicyName
        in: path
        required: true
        type: string
        description: The name of the compute policy to update.
      - name: parameters
        in: body
        required: false
        schema:
          $ref: '#/definitions/UpdateComputePolicyParameters'
        description: Parameters supplied to update the compute policy.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully updated the specified compute policy
          schema:
            $ref: '#/definitions/ComputePolicy'
        default:
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
          description: ''
      x-ms-examples:
        Updates the specified compute policy:
          $ref: ./examples/ComputePolicies_Update.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datalakeanalytics Accounts Accountname Computepolicies Computepolicyname
    delete:
      tags:
      - ComputePolicies
      operationId: microsoftAzureComputepoliciesDelete
      description: Deletes the specified compute policy from the specified Data Lake Analytics account
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - name: computePolicyName
        in: path
        required: true
        type: string
        description: The name of the compute policy to delete.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully deleted the specified compute policy
        '204':
          description: The specified compute policy does not exist or was already deleted.
        default:
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
          description: ''
      x-ms-examples:
        Deletes the specified compute policy from the adla account:
          $ref: ./examples/ComputePolicies_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datalakeanalytics Accounts Accountname Computepolicies Computepolicyname
definitions:
  ComputePolicyProperties:
    properties:
      objectId:
        readOnly: true
        type: string
        format: uuid
        description: The AAD object identifier for the entity to create a policy for.
      objectType:
        readOnly: true
        type: string
        enum:
        - User
        - Group
        - ServicePrincipal
        x-ms-enum:
          name: AADObjectType
          modelAsString: true
        description: The type of AAD object the object identifier refers to.
      maxDegreeOfParallelismPerJob:
        readOnly: true
        type: integer
        format: int32
        minimum: 1
        description: The maximum degree of parallelism per job this user can use to submit jobs.
      minPriorityPerJob:
        readOnly: true
        type: integer
        format: int32
        minimum: 1
        description: The minimum priority per job this user can use to submit jobs.
    description: The compute policy properties.
  ComputePolicy:
    allOf:
    - $ref: '#/definitions/SubResource'
    properties:
      properties:
        readOnly: true
        x-ms-client-flatten: true
        $ref: '#/definitions/ComputePolicyProperties'
        description: The compute policy properties.
    description: Data Lake Analytics compute policy information.
  CreateOrUpdateComputePolicyParameters:
    required:
    - properties
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/CreateOrUpdateComputePolicyProperties'
        description: The compute policy properties to use when creating a new compute policy.
    description: The parameters used to create a new compute policy.
  SubResource:
    properties:
      id:
        readOnly: true
        type: string
        description: The resource identifier.
      name:
        readOnly: true
        type: string
        description: The resource name.
      type:
        readOnly: true
        type: string
        description: The resource type.
    x-ms-azure-resource: true
    description: The resource model definition for a nested resource.
  ComputePolicyListResult:
    properties:
      value:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/ComputePolicy'
        description: The results of the list operation.
      nextLink:
        readOnly: true
        type: string
        description: The link (url) to the next page of results.
    description: The list of compute policies in the account.
  CreateOrUpdateComputePolicyProperties:
    required:
    - objectId
    - objectType
    properties:
      objectId:
        type: string
        format: uuid
        description: The AAD object identifier for the entity to create a policy for.
      objectType:
        type: string
        enum:
        - User
        - Group
        - ServicePrincipal
        x-ms-enum:
          name: AADObjectType
          modelAsString: true
        description: The type of AAD object the object identifier refers to.
      maxDegreeOfParallelismPerJob:
        type: integer
        format: int32
        minimum: 1
        description: The maximum degree of parallelism per job this user can use to submit jobs. This property, the min priority per job property, or both must be passed.
      minPriorityPerJob:
        type: integer
        format: int32
        minimum: 1
        description: The minimum priority per job this user can use to submit jobs. This property, the max degree of parallelism per job property, or both must be passed.
    description: The compute policy properties to use when creating a new compute policy.
  UpdateComputePolicyParameters:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/UpdateComputePolicyProperties'
        description: The compute policy properties to use when updating a compute policy.
    description: The parameters used to update a compute policy.
  UpdateComputePolicyProperties:
    properties:
      objectId:
        type: string
        format: uuid
        description: The AAD object identifier for the entity to create a policy for.
      objectType:
        type: string
        enum:
        - User
        - Group
        - ServicePrincipal
        x-ms-enum:
          name: AADObjectType
          modelAsString: true
        description: The type of AAD object the object identifier refers to.
      maxDegreeOfParallelismPerJob:
        type: integer
        format: int32
        minimum: 1
        description: The maximum degree of parallelism per job this user can use to submit jobs. This property, the min priority per job property, or both must be passed.
      minPriorityPerJob:
        type: integer
        format: int32
        minimum: 1
        description: The minimum priority per job this user can use to submit jobs. This property, the max degree of parallelism per job property, or both must be passed.
    description: The compute policy properties to use when updating a compute policy.
parameters:
  AccountNameParameter:
    name: accountName
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
    description: The name of the Data Lake Analytics account.
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
    description: The name of the Azure resource group.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'