Microsoft Azure ClusterExtensions API

openapi: 3.2.0
info:
  version: 2022-01-01-preview
  title: Microsoft Azure ExtensionsClient Cluster Extensions API
  description: Use these APIs to create extension resources through ARM, for Kubernetes Clusters.
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: ClusterExtensions
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/extensions/{extensionName}
  : put:
      tags:
      - ClusterExtensions
      description: Create a new Kubernetes Cluster Extension.
      operationId: microsoftAzureExtensionsCreate
      x-ms-examples:
        Create Extension:
          $ref: ./examples/CreateExtension.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterRpParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterResourceNameParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterNameParameter
      - $ref: '#/components/parameters/ExtensionNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Request received successfully for an existing resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Extension'
        '201':
          description: Request received successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Extension'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Extension'
        description: Properties necessary to Create an Extension.
        required: true
    get:
      tags:
      - ClusterExtensions
      description: Gets Kubernetes Cluster Extension.
      operationId: microsoftAzureExtensionsGet
      x-ms-examples:
        Get Extension:
          $ref: ./examples/GetExtension.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterRpParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterResourceNameParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterNameParameter
      - $ref: '#/components/parameters/ExtensionNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Extension'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    delete:
      tags:
      - ClusterExtensions
      description: Delete a Kubernetes Cluster Extension. This will cause the Agent to Uninstall the extension from the cluster.
      operationId: microsoftAzureExtensionsDelete
      x-ms-examples:
        Delete Extension:
          $ref: ./examples/DeleteExtension.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterRpParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterResourceNameParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterNameParameter
      - $ref: '#/components/parameters/ExtensionNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - name: forceDelete
        in: query
        description: Delete the extension resource in Azure - not the normal asynchronous delete.
        schema:
          type: boolean
      responses:
        '200':
          description: OK
        '202':
          description: Accepted.  The request has been accepted for processing.
        '204':
          description: No Content.  The request has been accepted but the extension was not found.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
    patch:
      tags:
      - ClusterExtensions
      description: Patch an existing Kubernetes Cluster Extension.
      operationId: microsoftAzureExtensionsUpdate
      x-ms-examples:
        Update Extension:
          $ref: ./examples/PatchExtension.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterRpParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterResourceNameParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterNameParameter
      - $ref: '#/components/parameters/ExtensionNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '202':
          description: Request received successfully, and the resource will be updated asynchronously.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Extension'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/patchExtension'
        description: Properties to Patch in an existing Extension.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/extensions
  : get:
      tags:
      - ClusterExtensions
      description: List all Extensions in the cluster.
      operationId: microsoftAzureExtensionsList
      x-ms-examples:
        List Extensions:
          $ref: ./examples/ListExtensions.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterRpParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterResourceNameParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterNameParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionsList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
components:
  schemas:
    Scope:
      description: Scope of the extension. It can be either Cluster or Namespace; but not both.
      type: object
      properties:
        cluster:
          type:
          - object
          - 'null'
          description: Specifies that the scope of the extension is Cluster
          $ref: '#/components/schemas/ScopeCluster'
        namespace:
          type:
          - object
          - 'null'
          description: Specifies that the scope of the extension is Namespace
          $ref: '#/components/schemas/ScopeNamespace'
    ExtensionStatus:
      description: Status from the extension.
      type: object
      readOnly: true
      properties:
        code:
          type: string
          description: Status code provided by the Extension
        displayStatus:
          type: string
          description: Short description of status of the extension.
        level:
          type: string
          description: Level of the status.
          enum:
          - Error
          - Warning
          - Information
          default: Information
          x-ms-enum:
            name: LevelType
            modelAsString: true
        message:
          type: string
          description: Detailed message of the status from the Extension.
        time:
          type: string
          description: DateLiteral (per ISO8601) noting the time of installation status.
    ScopeCluster:
      description: Specifies that the scope of the extension is Cluster
      type: object
      properties:
        releaseNamespace:
          description: Namespace where the extension Release must be placed, for a Cluster scoped extension.  If this namespace does not exist, it will be created
          type: string
    patchExtension:
      description: The Extension Patch Request object.
      type: object
      properties:
        properties:
          type: object
          x-ms-client-flatten: true
          description: Updatable properties of an Extension Patch Request
          properties:
            autoUpgradeMinorVersion:
              description: Flag to note if this extension participates in auto upgrade of minor version, or not.
              type: boolean
              default: true
            releaseTrain:
              description: ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'.
              type: string
              default: Stable
            version:
              description: Version of the extension for this extension, if it is 'pinned' to a specific version. autoUpgradeMinorVersion must be 'false'.
              type: string
            configurationSettings:
              description: Configuration settings, as name-value pairs for configuring this extension.
              type:
              - object
              - 'null'
              additionalProperties:
                type: string
            configurationProtectedSettings:
              description: Configuration settings that are sensitive, as name-value pairs for configuring this extension.
              type:
              - object
              - 'null'
              x-ms-secret: true
              additionalProperties:
                type: string
    ExtensionsList:
      description: Result of the request to list Extensions.  It contains a list of Extension objects and a URL link to get the next set of results.
      type: object
      properties:
        value:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/Extension'
          description: List of Extensions within a Kubernetes cluster.
        nextLink:
          type: string
          readOnly: true
          description: URL to get the next set of extension objects, if any.
    ScopeNamespace:
      description: Specifies that the scope of the extension is Namespace
      type: object
      properties:
        targetNamespace:
          description: Namespace where the extension will be created for an Namespace scoped extension.  If this namespace does not exist, it will be created
          type: string
    Extension:
      description: The Extension object.
      type: object
      properties:
        properties:
          type: object
          x-ms-client-flatten: true
          description: Properties of an Extension resource
          properties:
            extensionType:
              description: Type of the Extension, of which this resource is an instance of.  It must be one of the Extension Types registered with Microsoft.KubernetesConfiguration by the Extension publisher.
              type: string
            autoUpgradeMinorVersion:
              description: Flag to note if this extension participates in auto upgrade of minor version, or not.
              type: boolean
              default: true
            releaseTrain:
              description: ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'.
              type: string
              default: Stable
            version:
              description: Version of the extension for this extension, if it is 'pinned' to a specific version. autoUpgradeMinorVersion must be 'false'.
              type: string
            scope:
              description: Scope at which the extension is installed.
              $ref: '#/components/schemas/Scope'
            configurationSettings:
              description: Configuration settings, as name-value pairs for configuring this extension.
              type:
              - object
              - 'null'
              additionalProperties:
                type: string
            configurationProtectedSettings:
              description: Configuration settings that are sensitive, as name-value pairs for configuring this extension.
              type:
              - object
              - 'null'
              x-ms-secret: true
              additionalProperties:
                type: string
            provisioningState:
              description: Status of installation of this extension.
              type: string
              readOnly: true
              $ref: ../../common/2022-01-01-preview/definitions.json#/definitions/ProvisioningStateDefinition
            statuses:
              description: Status from this extension.
              type:
              - array
              - 'null'
              items:
                $ref: '#/components/schemas/ExtensionStatus'
            errorInfo:
              description: Error information from the Agent - e.g. errors during installation.
              type:
              - object
              - 'null'
              readOnly: true
              $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail
            customLocationSettings:
              description: Custom Location settings properties.
              type:
              - object
              - 'null'
              readOnly: true
              additionalProperties:
                type: string
            packageUri:
              description: Uri of the Helm package
              type:
              - string
              - 'null'
              readOnly: true
            aksAssignedIdentity:
              description: Identity of the Extension resource in an AKS cluster
              type:
              - object
              - 'null'
              properties:
                principalId:
                  readOnly: true
                  type: string
                  description: The principal ID of resource identity.
                tenantId:
                  readOnly: true
                  type: string
                  description: The tenant ID of resource.
                type:
                  type: string
                  description: The identity type.
                  enum:
                  - SystemAssigned
                  x-ms-enum:
                    name: ResourceIdentityType
                    modelAsString: false
        identity:
          description: Identity of the Extension resource
          $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/Identity
        systemData:
          description: Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources
          $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
      allOf:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource
  parameters:
    ExtensionNameParameter:
      name: extensionName
      in: path
      description: Name of the Extension.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow