swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector customizationPolicies API
  description: Customization policies operations
schemes:
- https
tags:
- description: Customization policies operations
  name: customizationPolicies
paths:
  ? /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/customizationPolicies
  : get:
      description: Returns list of customization policies in region for private cloud
      produces:
      - application/json
      tags:
      - customizationPolicies
      summary: Microsoft Azure Implements Get Of Customization Policies List
      operationId: microsoftAzureCustomizationpoliciesList
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/regionId'
      - $ref: '#/parameters/pcName'
      - $ref: '#/parameters/api-version'
      - type: string
        description: The filter to apply on the list operation. only type is allowed here as a filter e.g. $filter=type eq 'xxxx'
        name: $filter
        in: query
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/CustomizationPoliciesListResponse'
        default:
          description: General Error
          schema:
            $ref: '#/definitions/CSRPError'
      x-ms-examples:
        ListCustomizationPolicies:
          $ref: ./examples/ListCustomizationPolicies.json
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/customizationPolicies/{customizationPolicyName}
  : get:
      description: Returns customization policy by its name
      produces:
      - application/json
      tags:
      - customizationPolicies
      summary: Microsoft Azure Implements Get Of Customization Policy
      operationId: microsoftAzureCustomizationpoliciesGet
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/regionId'
      - $ref: '#/parameters/pcName'
      - type: string
        description: customization policy name
        name: customizationPolicyName
        in: path
        required: true
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/CustomizationPolicy'
        default:
          description: General Error
          schema:
            $ref: '#/definitions/CSRPError'
      x-ms-examples:
        GetCustomizationPolicy:
          $ref: ./examples/GetCustomizationPolicy.json
definitions:
  CustomizationHostName:
    description: Host name model
    type: object
    properties:
      name:
        description: Hostname
        type: string
      type:
        description: Type of host name
        type: string
        enum:
        - USER_DEFINED
        - PREFIX_BASED
        - FIXED
        - VIRTUAL_MACHINE_NAME
        - CUSTOM_NAME
  CustomizationPolicyProperties:
    description: The properties of Customization policy
    type: object
    properties:
      description:
        description: Policy description
        type: string
      privateCloudId:
        description: The Private cloud id
        type: string
      specification:
        description: Detailed customization policy specification
        $ref: '#/definitions/CustomizationSpecification'
      type:
        description: The type of customization (Linux or Windows)
        type: string
        enum:
        - LINUX
        - WINDOWS
      version:
        description: Policy version
        type: string
  CustomizationIPAddress:
    type: object
    properties:
      argument:
        description: Argument when Custom ip type is selected
        type: string
      ipAddress:
        description: Defined Ip Address when Fixed ip type is selected
        type: string
      type:
        description: Customization Specification ip type
        type: string
        enum:
        - CUSTOM
        - DHCP_IP
        - FIXED_IP
        - USER_DEFINED
  CustomizationIPSettings:
    type: object
    properties:
      gateway:
        description: The list of gateways
        type: array
        items:
          type: string
      ip:
        description: Ip address customization settings
        $ref: '#/definitions/CustomizationIPAddress'
      subnetMask:
        description: Adapter subnet mask
        type: string
  CustomizationSpecification:
    description: The specification for Customization Policy
    type: object
    properties:
      identity:
        description: Customization Identity. It contains data about user and hostname
        $ref: '#/definitions/CustomizationIdentity'
      nicSettings:
        description: Network interface settings
        type: array
        items:
          $ref: '#/definitions/CustomizationNicSetting'
        x-ms-identifiers:
        - macAddress
  CustomizationNicSetting:
    type: object
    properties:
      adapter:
        description: The list of adapters' settings
        $ref: '#/definitions/CustomizationIPSettings'
      macAddress:
        description: NIC mac address
        type: string
  CSRPError:
    description: General error model
    properties:
      error:
        description: Error's body
        $ref: '#/definitions/CSRPErrorBody'
  CustomizationIdentity:
    type: object
    properties:
      data:
        description: Windows Text Identity. Prepared data
        type: string
      hostName:
        description: Virtual machine host name settings
        $ref: '#/definitions/CustomizationHostName'
      type:
        description: Identity type
        type: string
        enum:
        - WINDOWS_TEXT
        - WINDOWS
        - LINUX
      userData:
        description: Windows Identity. User data customization
        type: object
        properties:
          isPasswordPredefined:
            description: Is password predefined in customization policy
            type: boolean
            default: false
  CustomizationPoliciesListResponse:
    description: List of customization polices response model
    properties:
      nextLink:
        description: Link for next list of the Customization policy
        type: string
      value:
        description: List of the customization policies
        type: array
        items:
          $ref: '#/definitions/CustomizationPolicy'
  CSRPErrorBody:
    description: Error properties
    properties:
      code:
        description: Error's code
        type: string
        readOnly: true
      details:
        description: Error's details
        type: array
        items:
          $ref: '#/definitions/CSRPErrorBody'
        x-ms-identifiers: []
        readOnly: true
      message:
        description: Error's message
        type: string
        readOnly: true
      target:
        description: Error's target
        type: string
  CustomizationPolicy:
    description: The virtual machine customization policy
    type: object
    properties:
      id:
        description: Customization policy azure id
        type: string
      location:
        description: Azure region
        type: string
      name:
        description: Customization policy name
        type: string
        readOnly: true
      properties:
        description: Customization Policy properties
        x-ms-client-flatten: true
        $ref: '#/definitions/CustomizationPolicyProperties'
      type:
        type: string
        readOnly: true
parameters:
  pcName:
    type: string
    x-ms-parameter-location: method
    description: The private cloud name
    name: pcName
    in: path
    required: true
  subscriptionId:
    type: string
    description: The subscription ID.
    name: subscriptionId
    in: path
    required: true
  api-version:
    type: string
    description: Client API version.
    name: api-version
    in: query
    required: true
  regionId:
    type: string
    x-ms-parameter-location: method
    description: The region Id (westus, eastus)
    name: regionId
    in: path
    required: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'