swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector PrivateLinkResource API
schemes:
- https
tags:
- name: PrivateLinkResource
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources
  : get:
      tags:
      - PrivateLinkResource
      operationId: microsoftAzurePrivatelinkresourceListbybatchaccount
      description: Lists all of the private link resources in the specified account.
      x-ms-examples:
        ListPrivateLinkResource:
          $ref: ./examples/PrivateLinkResourcesList.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: maxresults
        in: query
        required: false
        type: integer
        format: int32
        description: The maximum number of items to return in the response.
      responses:
        '200':
          description: The operation was successful. The response contains a list of private link resources associated with the account.
          schema:
            $ref: '#/definitions/ListPrivateLinkResourcesResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Privatelinkresources
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources/{privateLinkResourceName}
  : get:
      tags:
      - PrivateLinkResource
      operationId: microsoftAzurePrivatelinkresourceGet
      description: Gets information about the specified private link resource.
      x-ms-examples:
        GetPrivateLinkResource:
          $ref: ./examples/PrivateLinkResourceGet.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/PrivateLinkResourceNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The operation was successful. The response contains the private link resource.
          schema:
            $ref: '#/definitions/PrivateLinkResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Privatelinkresources Privatelinkresourcename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateLinkResources
  : get:
      tags:
      - PrivateLinkResource
      summary: Microsoft Azure Gets A List Of Privately Linkable Resources For An Account
      description: Gets a list of privately linkable resources for an account
      operationId: microsoftAzurePrivatelinkresourcesListbyaccount
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/accountName'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PrivateLinkResourceList'
        default:
          description: An error response received from the provider.
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        PrivateLinkResources_ListByAccount:
          $ref: ./examples/PrivateLinkResources_ListByAccount.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateLinkResources/{groupId}
  : get:
      tags:
      - PrivateLinkResource
      summary: Microsoft Azure Gets A Privately Linkable Resources For An Account With Given Group Identifier
      description: Gets a privately linkable resources for an account with given group identifier
      operationId: microsoftAzurePrivatelinkresourcesGetbygroupid
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/accountName'
      - name: groupId
        in: path
        description: The group identifier.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PrivateLinkResource_3'
        default:
          description: An error response received from the provider.
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        PrivateLinkResources_GetByGroupId:
          $ref: ./examples/PrivateLinkResources_GetByGroupId.json
definitions:
  PrivateLinkResourceList:
    description: Paged list of private link resources
    required:
    - value
    type: object
    properties:
      count:
        format: int64
        description: Total item count.
        type: integer
      nextLink:
        description: The Url of next result page.
        type: string
      value:
        description: Collection of items of type results.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/PrivateLinkResource_3'
  ProxyResource:
    properties:
      id:
        readOnly: true
        type: string
        description: The ID of the resource.
      name:
        readOnly: true
        type: string
        description: The name of the resource.
      type:
        readOnly: true
        type: string
        description: The type of the resource.
      etag:
        readOnly: true
        type: string
        description: The ETag of the resource, used for concurrency statements.
    description: A definition of an Azure resource.
    x-ms-azure-resource: true
  ErrorModel:
    description: Default error model
    type: object
    properties:
      code:
        description: Gets or sets the code.
        type: string
        readOnly: true
      details:
        description: Gets or sets the details.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/ErrorModel'
        readOnly: true
      message:
        description: Gets or sets the messages.
        type: string
        readOnly: true
      target:
        description: Gets or sets the target.
        type: string
        readOnly: true
  CloudErrorBody:
    x-ms-external: true
    properties:
      code:
        type: string
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
      message:
        type: string
        description: A message describing the error, intended to be suitable for display in a user interface.
      target:
        type: string
        description: The target of the particular error. For example, the name of the property in error.
      details:
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
        description: A list of additional details about the error.
    description: An error response from the Batch service.
  PrivateLinkResourceProperties_3:
    description: A privately linkable resource properties.
    type: object
    properties:
      groupId:
        description: The private link resource group identifier.
        type: string
        readOnly: true
      requiredMembers:
        description: This translates to how many Private IPs should be created for each privately linkable resource.
        uniqueItems: false
        type: array
        items:
          type: string
        readOnly: true
      requiredZoneNames:
        description: The required zone names for private link resource.
        uniqueItems: false
        type: array
        items:
          type: string
        readOnly: true
  PrivateLinkResource:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/PrivateLinkResourceProperties'
        description: The properties associated with the private link resource.
    allOf:
    - $ref: '#/definitions/ProxyResource'
    description: Contains information about a private link resource.
  ListPrivateLinkResourcesResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/PrivateLinkResource'
        description: The collection of returned private link resources.
      nextLink:
        type: string
        description: The continuation token.
    description: Values returned by the List operation.
  PrivateLinkResource_3:
    description: A privately linkable resource.
    type: object
    properties:
      id:
        description: The private link resource identifier.
        type: string
        readOnly: true
      name:
        description: The private link resource name.
        type: string
        readOnly: true
      properties:
        $ref: '#/definitions/PrivateLinkResourceProperties_3'
        description: The private link resource properties.
        readOnly: true
      type:
        description: The private link resource type.
        type: string
        readOnly: true
  ErrorResponseModel:
    description: Default error response model
    type: object
    properties:
      error:
        description: Gets or sets the error.
        allOf:
        - $ref: '#/definitions/ErrorModel'
        readOnly: true
  CloudError:
    x-ms-external: true
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
    description: An error response from the Batch service.
  PrivateLinkResourceProperties:
    properties:
      groupId:
        type: string
        title: The group id of the private link resource.
        description: The group id is used to establish the private link connection.
        readOnly: true
      requiredMembers:
        type: array
        items:
          type: string
        title: The list of required members that are used to establish the private link connection.
        readOnly: true
      requiredZoneNames:
        type: array
        items:
          type: string
        title: The list of required zone names for the private DNS resource name
        readOnly: true
    description: Private link resource properties.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: The API version to be used with the HTTP request.
  resourceGroupName:
    name: resourceGroupName
    in: path
    description: The resource group name.
    required: true
    type: string
    x-ms-parameter-location: method
  api-version:
    name: api-version
    in: query
    description: The api version to use.
    required: true
    type: string
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    description: The name of the resource group that contains the Batch account.
    x-ms-parameter-location: method
  AccountNameParameter:
    name: accountName
    in: path
    required: true
    type: string
    pattern: ^[a-zA-Z0-9]+$
    minLength: 3
    maxLength: 24
    description: The name of the Batch account.
    x-ms-parameter-location: method
  subscriptionId:
    name: subscriptionId
    in: path
    description: The subscription identifier
    required: true
    type: string
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
  accountName:
    name: accountName
    in: path
    description: The name of the account.
    required: true
    type: string
    maxLength: 63
    minLength: 3
    pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
    x-ms-parameter-location: method
  PrivateLinkResourceNameParameter:
    name: privateLinkResourceName
    in: path
    required: true
    type: string
    pattern: ^[a-zA-Z0-9_-]+\.?[a-fA-F0-9-]*$
    minLength: 1
    maxLength: 101
    description: The private link resource name. This must be unique within the account.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'