Microsoft Azure Addons API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Addons API
schemes:
- https
tags:
- name: Addons
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons
  : get:
      operationId: microsoftAzureAddonsList
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Addons
      summary: Microsoft Azure List Addons In A Private Cloud
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/privateCloudName'
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AddonList'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Addons_List:
          $ref: ./examples/Addons_List.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName}
  : get:
      operationId: microsoftAzureAddonsGet
      tags:
      - Addons
      summary: Microsoft Azure Get An Addon By Name In A Private Cloud
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/privateCloudName'
      - $ref: '#/parameters/addonName'
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/Addon'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Addons_Get:
          $ref: ./examples/Addons_Get.json
      description: Needs a more full description created.
    put:
      operationId: microsoftAzureAddonsCreateorupdate
      x-ms-long-running-operation: true
      tags:
      - Addons
      summary: Microsoft Azure Create Or Update A Addon In A Private Cloud
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - name: privateCloudName
        in: path
        required: true
        type: string
        description: The name of the private cloud.
      - $ref: '#/parameters/addonName'
      - name: addon
        description: A addon in the private cloud
        in: body
        required: true
        schema:
          $ref: '#/definitions/Addon'
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/Addon'
        '201':
          description: accepted operation
          schema:
            $ref: '#/definitions/Addon'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Addons_CreateOrUpdate:
          $ref: ./examples/Addons_CreateOrUpdate.json
      description: Needs a more full description created.
    delete:
      operationId: microsoftAzureAddonsDelete
      x-ms-long-running-operation: true
      tags:
      - Addons
      summary: Microsoft Azure Delete A Addon In A Private Cloud
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/privateCloudName'
      - $ref: '#/parameters/addonName'
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The delete has succeeded
        '202':
          description: Accepted. The delete will complete asynchronously
        '204':
          description: No Content. No addon to delete
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Addons_Delete:
          $ref: ./examples/Addons_Delete.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons
  : get:
      tags:
      - Addons
      description: Lists all the addons configured in the role.
      operationId: microsoftAzureAddonsListbyrole
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: roleName
        in: path
        description: The role name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: List of all the addons configured in the role.
          schema:
            $ref: '#/definitions/AddonList_2'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_2'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        RoleListAddOns:
          $ref: ./examples/RoleListAddOns.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Roles Rolename Addons
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons/{addonName}
  : get:
      tags:
      - Addons
      description: Gets a specific addon by name.
      operationId: microsoftAzureAddonsGet
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: roleName
        in: path
        description: The role name.
        required: true
        type: string
      - name: addonName
        in: path
        description: The addon name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The addon with the specified name in the role.
          schema:
            $ref: '#/definitions/Addon_2'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_2'
      x-ms-examples:
        GetAddOns:
          $ref: ./examples/GetAddons.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Roles Rolename Addons Addonname
    put:
      tags:
      - Addons
      description: Create or update a addon.
      operationId: microsoftAzureAddonsCreateorupdate
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: roleName
        in: path
        description: The role name.
        required: true
        type: string
      - name: addonName
        in: path
        description: The addon name.
        required: true
        type: string
      - name: addon
        in: body
        description: The addon properties.
        required: true
        schema:
          $ref: '#/definitions/Addon_2'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully created or updated the addon.
          schema:
            $ref: '#/definitions/Addon_2'
        '202':
          description: Accepted the request to create or update the addon.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_2'
      x-ms-long-running-operation: true
      x-ms-examples:
        PutAddOns:
          $ref: ./examples/PutAddons.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Roles Rolename Addons Addonname
    delete:
      tags:
      - Addons
      description: Deletes the addon on the device.
      operationId: microsoftAzureAddonsDelete
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: roleName
        in: path
        description: The role name.
        required: true
        type: string
      - name: addonName
        in: path
        description: The addon name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully deleted the addon.
        '202':
          description: Accepted the request to delete the addon.
        '204':
          description: The addon is already deleted.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_2'
      x-ms-long-running-operation: true
      x-ms-examples:
        DeleteAddOns:
          $ref: ./examples/DeleteAddons.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Roles Rolename Addons Addonname
definitions:
  AddonList:
    description: A paged list of addons
    properties:
      value:
        description: The items on a page
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/Addon'
      nextLink:
        description: URL to get the next page if any
        type: string
        readOnly: true
  AddonProperties:
    description: The properties of an addon that may be updated
    allOf:
    - $ref: '#/definitions/AddonSrmProperties'
    properties:
      addonType:
        description: The type of private cloud addon
        type: string
        enum:
        - SRM
        - VR
        x-ms-enum:
          name: AddonType
          modelAsString: true
      provisioningState:
        description: The state of the addon provisioning
        type: string
        readOnly: true
        enum:
        - Succeeded
        - Failed
        - Cancelled
        - Deleting
        - Updating
        x-ms-enum:
          name: AddonProvisioningState
          modelAsString: true
  Resource:
    description: The core properties of ARM resources
    properties:
      id:
        description: Resource ID.
        readOnly: true
        type: string
      name:
        description: Resource name.
        readOnly: true
        type: string
      type:
        description: Resource type.
        readOnly: true
        type: string
    x-ms-azure-resource: true
  ARMBaseModel:
    description: Represents the base class for all object models.
    type: object
    properties:
      id:
        description: The path ID that uniquely identifies the object.
        type: string
        readOnly: true
      name:
        description: The object name.
        type: string
        readOnly: true
      type:
        description: The hierarchical type of the object.
        type: string
        readOnly: true
    x-ms-azure-resource: true
  CloudError:
    x-ms-external: true
    properties:
      error:
        description: An error returned by the API
        $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse
    description: API error response
  AddonList_2:
    description: Collection of all the Role addon on the Azure Stack Edge device.
    type: object
    properties:
      value:
        description: The Value.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/Addon_2'
        readOnly: true
        x-ms-identifiers: []
      nextLink:
        description: Link to the next set of results.
        type: string
        readOnly: true
  Addon:
    description: An addon resource
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        description: The properties of an addon resource
        $ref: '#/definitions/AddonProperties'
        x-ms-client-flatten: true
  CloudErrorBody:
    description: An error response from the service.
    type: object
    properties:
      code:
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
        type: string
      message:
        description: A message describing the error, intended to be suitable for display in a user interface.
        type: string
      details:
        description: A list of additional details about the error.
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
        x-ms-identifiers: []
    x-ms-external: true
  Addon_2:
    description: Role Addon
    required:
    - kind
    type: object
    allOf:
    - $ref: '#/definitions/ARMBaseModel'
    properties:
      kind:
        description: Addon type.
        enum:
        - IotEdge
        - ArcForKubernetes
        type: string
        x-ms-enum:
          name: AddonType
          modelAsString: true
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: Metadata pertaining to creation and last modification of Addon
        readOnly: true
    discriminator: kind
  AddonSrmProperties:
    description: The properties of an SRM addon that may be updated
    properties:
      licenseKey:
        description: The SRM license
        type: string
  CloudError_2:
    description: An error response from the service.
    type: object
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
        description: The error details.
    x-ms-external: true
parameters:
  addonName:
    name: addonName
    in: path
    required: true
    type: string
    description: Name of the addon for the private cloud
    x-ms-parameter-location: method
  privateCloudName:
    name: privateCloudName
    in: path
    required: true
    type: string
    description: Name of the private cloud
    x-ms-parameter-location: method
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The subscription ID.
    required: true
    type: string
  apiVersionParameter:
    name: api-version
    in: query
    description: The API version.
    required: true
    type: string
  resourceGroupNameParameter:
    name: resourceGroupName
    in: path
    description: The resource group name.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'