Microsoft Azure
Microsoft Azure Extensions API

The Extensions API from Microsoft Azure — 8 operation(s) for extensions.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Extensions API
schemes:
- https
tags:
- name: Extensions
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{dataManagerForAgricultureResourceName}/extensions/{extensionId}
  : put:
      tags:
      - Extensions
      description: Install or Update extension. Additional Api Properties are merged patch and if the extension is updated to a new version then the obsolete entries will be auto deleted from Additional Api Properties.
      operationId: microsoftAzureExtensionsCreateorupdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/DataManagerForAgricultureResourceNameParameter'
      - $ref: '#/parameters/ExtensionIdParameter'
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      - in: body
        name: requestBody
        description: Extension resource request body.
        schema:
          $ref: '#/definitions/ExtensionInstallationRequest'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Extension'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Extensions_CreateOrUpdate:
          $ref: ./examples/Extensions_CreateOrUpdate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Datamanagerforagricultureresourcename Extensions Extensionid
    get:
      tags:
      - Extensions
      description: Get installed extension details by extension id.
      operationId: microsoftAzureExtensionsGet
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/DataManagerForAgricultureResourceNameParameter'
      - $ref: '#/parameters/ExtensionIdParameter'
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Extension'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Extensions_Get:
          $ref: ./examples/Extensions_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Datamanagerforagricultureresourcename Extensions Extensionid
    delete:
      tags:
      - Extensions
      description: Uninstall extension.
      operationId: microsoftAzureExtensionsDelete
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/DataManagerForAgricultureResourceNameParameter'
      - $ref: '#/parameters/ExtensionIdParameter'
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
        '204':
          description: No Content
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Extensions_Delete:
          $ref: ./examples/Extensions_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Datamanagerforagricultureresourcename Extensions Extensionid
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{dataManagerForAgricultureResourceName}/extensions
  : get:
      tags:
      - Extensions
      description: Get installed extensions details.
      operationId: microsoftAzureExtensionsListbydatamanagerforagriculture
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/DataManagerForAgricultureResourceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      - in: query
        name: extensionIds
        description: Installed extension ids.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: extensionCategories
        description: Installed extension categories.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: $maxPageSize
        description: "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50."
        type: integer
        format: int32
        default: 50
        maximum: 1000
        minimum: 10
      - in: query
        name: $skipToken
        description: Skip token for getting next set of results.
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ExtensionListResponse'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Extensions_ListByDataManagerForAgriculture:
          $ref: ./examples/Extensions_ListByDataManagerForAgriculture.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Datamanagerforagricultureresourcename Extensions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions/{extensionId}
  : put:
      tags:
      - Extensions
      description: Install extension.
      operationId: microsoftAzureExtensionsCreate
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ExtensionIdParameter'
      - $ref: '#/parameters/FarmBeatsResourceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '201':
          description: Success
          schema:
            $ref: '#/definitions/Extension_2'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Extensions_Create:
          $ref: ./examples/Extensions_Create.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Farmbeatsresourcename Extensions Extensionid
    get:
      tags:
      - Extensions
      description: Get installed extension details by extension id.
      operationId: microsoftAzureExtensionsGet
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ExtensionIdParameter'
      - $ref: '#/parameters/FarmBeatsResourceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Extension_2'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Extensions_Get:
          $ref: ./examples/Extensions_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Farmbeatsresourcename Extensions Extensionid
    patch:
      tags:
      - Extensions
      description: Upgrade to latest extension.
      operationId: microsoftAzureExtensionsUpdate
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ExtensionIdParameter'
      - $ref: '#/parameters/FarmBeatsResourceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Extension_2'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Extensions_Update:
          $ref: ./examples/Extensions_Update.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Farmbeatsresourcename Extensions Extensionid
    delete:
      tags:
      - Extensions
      description: Uninstall extension.
      operationId: microsoftAzureExtensionsDelete
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ExtensionIdParameter'
      - $ref: '#/parameters/FarmBeatsResourceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
        '204':
          description: Success
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Extensions_Delete:
          $ref: ./examples/Extensions_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Farmbeatsresourcename Extensions Extensionid
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions
  : get:
      tags:
      - Extensions
      description: Get installed extensions details.
      operationId: microsoftAzureExtensionsListbyfarmbeats
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/FarmBeatsResourceNameParameter'
      - in: query
        name: extensionIds
        description: Installed extension ids.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: extensionCategories
        description: Installed extension categories.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: $maxPageSize
        description: "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50."
        type: integer
        format: int32
        default: 50
        maximum: 1000
        minimum: 10
      - in: query
        name: $skipToken
        description: Skip token for getting next set of results.
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ExtensionListResponse_2'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Extensions_ListByFarmBeats:
          $ref: ./examples/Extensions_ListByFarmBeats.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Farmbeatsresourcename Extensions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/extensions/{extensionName}
  : put:
      tags:
      - Extensions
      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: '#/parameters/ExtensionNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - name: extension
        in: body
        required: true
        schema:
          $ref: '#/definitions/Extension_3'
        description: Properties necessary to Create an Extension.
      responses:
        '200':
          description: Request received successfully for an existing resource.
          schema:
            $ref: '#/definitions/Extension_3'
        '201':
          description: Request received successfully.
          schema:
            $ref: '#/definitions/Extension_3'
        default:
          description: Error response describing why the operation failed.
          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 Resourcegroupname Providers Clusterrp Clusterresourcename Clustername Providers Microsoft Kubernetesconfiguration Extensions Extensionname
    get:
      tags:
      - Extensions
      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: '#/parameters/ExtensionNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Extension_3'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Clusterrp Clusterresourcename Clustername Providers Microsoft Kubernetesconfiguration Extensions Extensionname
    delete:
      tags:
      - Extensions
      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: '#/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.
        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.
          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 Resourcegroupname Providers Clusterrp Clusterresourcename Clustername Providers Microsoft Kubernetesconfiguration Extensions Extensionname
    patch:
      tags:
      - Extensions
      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: '#/parameters/ExtensionNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - name: patchExtension
        in: body
        required: true
        schema:
          $ref: '#/definitions/patchExtension'
        description: Properties to Patch in an existing Extension.
      responses:
        '202':
          description: Request received successfully, and the resource will be updated asynchronously.
          schema:
            $ref: '#/definitions/Extension_3'
        default:
          description: Error response describing why the operation failed.
          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 Resourcegroupname Providers Clusterrp Clusterresourcename Clustername Providers Microsoft Kubernetesconfiguration Extensions Extensionname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/extensions
  : get:
      tags:
      - Extensions
      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
          schema:
            $ref: '#/definitions/ExtensionsList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Clusterrp Clusterresourcename Clustername Providers Microsoft Kubernetesconfiguration Extensions
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.visualstudio/account/{accountResourceName}/extension
  : get:
      tags:
      - Extensions
      summary: Microsoft Azure Extensions Listbyaccount
      description: Gets the details of the extension resources created within the resource group.
      operationId: microsoftAzureExtensionsListbyaccount
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - in: path
        name: accountResourceName
        description: The name of the Visual Studio Team Services account resource.
        required: true
        type: string
      responses:
        '200':
          description: The operation succeeded. The response contains all extension resource details for the specified account.
          schema:
            $ref: '#/definitions/ExtensionResourceListResult'
      x-ms-examples:
        Get a list of extension resources within the resource group:
          $ref: ./examples/GetExtensionResources_List.json
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.visualstudio/account/{accountResourceName}/extension/{extensionResourceName}
  : put:
      tags:
      - Extensions
      summary: Microsoft Azure Extensions Create
      description: Registers the extension with a Visual Studio Team Services account.
      operationId: microsoftAzureExtensionsCreate
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - in: body
        name: body
        description: An object containing additional information related to the extension request.
        required: true
        schema:
          $ref: '#/definitions/ExtensionResourceRequest'
      - in: path
        name: accountResourceName
        description: The name of the Visual Studio Team Services account resource.
        required: true
        type: string
      - in: path
        name: extensionResourceName
        description: The name of the extension.
        required: true
        type: string
      responses:
        '200':
          description: The operation succeeded. The extension resource was created for the specified account.
          schema:
            $ref: '#/definitions/ExtensionResource'
      x-ms-examples:
        Create an extension resource:
          $ref: ./examples/CreateExtensionResource.json
    delete:
      tags:
      - Extensions
      summary: Microsoft Azure Extensions Delete
      description: Removes an extension resource registration for a Visual Studio Team Services account.
      operationId: microsoftAzureExtensionsDelete
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - in: path
        name: accountResourceName
        description: The name of the Visual Studio Team Services account resource.
        required: true
        type: string
      - in: path
        name: extensionResourceName
        description: The name of the extension.
        required: true
        type: string
      responses:
        '200':
          description: The operation succeeded. The extension resource has been deleted for the specified account.
      x-ms-examples:
        Delete an extension resource:
          $ref: ./examples/DeleteExtensionResource.json
    get:
      tags:
      - Extensions
      summary: Microsoft Azure Extensions Get
      description: Gets the details of an extension associated with a Visual Studio Team Services account resource.
      operationId: microsoftAzureExtensionsGet
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - in: path
        name: accountResourceName
        description: The name of the Visual Studio Team Services account resource.
        required: true
        type: string
      - in: path
        name: extensionResourceName
        description: The name of the extension.
        required: true
        type: string
      responses:
        '200':
          description: The operation succeeded. The response contains the extension resource details for the specified account.
          schema:
            $ref: '#/definitions/ExtensionResource'
        '404':
          description: The specified extension has no plans defined.
      x-ms-examples:
        Get an extension resource:
          $ref: ./examples/GetExtensionResource.json
    patch:
      tags:
      - Extensions
      summary: Microsoft Azure Extensions Update
      description: Updates an existing extension registration for the Visual Studio Team Services account.
      operationId: microsoftAzureExtensionsUpdate
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - in: body
        name: body
        description: An object containing additional information related to the extension request.
        required: true
        schema:
          $ref: '#/definitions/ExtensionResourceRequest'
      - in: path
        name: accountResourceName
        description: The name of the Visual Studio Team Services account resource.
        required: true
        type: string
      - in: path
        name: extensionResourceName
        description: The name of the extension.
        required: true
        type: string
      responses:
        '200':
          description: The operation succeeded. The extension resource was updated for the specified account.
          schema:
            $ref: '#/definitions/ExtensionResource'
      x-ms-examples:
        Update an extension resource:
          $ref: ./examples/UpdateExtensionResource.json
definitions:
  Scope:
    description: Scope of the extension. It can be either Cluster or Namespace; but not both.
    type: object
    properties:
      cluster:
        type: object
        x-nullable: true
        description: Specifies that the scope of the extension is Cluster
        $ref: '#/definitions/ScopeCluster'
      namespace:
        type: object
        x-nullable: true
        description: Specifies that the scope of the extension is Namespace
        $ref: '#/definitions/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.
  ExtensionListResponse_2:
    description: Paged response contains list of requested objects and a URL link to get the next set of results.
    type: object
    properties:
      value:
        description: List of requested objects.
        type: array
        items:
          $ref: '#/definitions/Extension_2'
      nextLink:
        description: Continuation link (absolute URI) to the next page of results in the list.
        type: string
        readOnly: true
  Resource:
    description: A generic Azure Resource Manager resource.
    x-ms-azure-resource: true
    type: object
    properties:
      id:
        description: Unique identifier of the resource.
        readOnly: true
        type: string
      location:
        description: Resource location.
        type: string
      name:
        description: Resource name.
        readOnly: true
        type: string
      tags:
        description: Resource tags.
        type: object
        additionalProperties:
          type: string
      type:
        description: Resource type.
        readOnly: true
        type: string
  ExtensionInstallationRequest:
    description: Extension Installation Request Body.
    type: object
    properties:
      extensionVersion:
        description: Extension Version.
        default: null
        maxLength: 10
        minLength: 3
        type: string
      additionalApiProperties:
        description: Additional Api Properties.
        type: object
        additionalProperties:
          $ref: '#/definitions/ApiProperties'
  ExtensionListResponse:
    description: Paged response contains list of requested objects and a URL link to get the next set of results.
    required:
    - value
    type: object
    properties:
      value:
        description: List of requested objects.
        type: array
        items:
          $ref: '#/definitions/Extension'
      $skipToken:
        description: Token used in retrieving the next page. If null, there are no addition

# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-extensions-api-openapi.yml
Microsoft Azure Extensions API

Documentation

Specifications

Other Resources

OpenAPI Specification
