Azure Service Fabric Cluster Version API

openapi: 3.2.0
info:
  title: ServiceFabricManagementClient Cluster Version API
  description: Azure Service Fabric Resource Provider API Client
  version: '2021-06-01'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: ClusterVersion
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/clusterVersions/{clusterVersion}:
    get:
      operationId: ClusterVersions_Get
      summary: Gets information about a Service Fabric cluster code version available in the…
      description: Gets information about an available Service Fabric cluster code version.
      parameters:
      - $ref: '#/components/parameters/locationForClusterCodeVersions'
      - $ref: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/clusterVersion'
      x-ms-examples:
        Get cluster version:
          $ref: ./examples/ClusterVersionsGet_example.json
      tags:
      - ClusterVersion
      responses:
        '200':
          description: The operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterCodeVersionsListResult'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
  ? /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/clusterVersions/{clusterVersion}
  : get:
      operationId: ClusterVersions_GetByEnvironment
      summary: Gets information about a Service Fabric cluster code version available for the…
      description: Gets information about an available Service Fabric cluster code version by environment.
      parameters:
      - $ref: '#/components/parameters/locationForClusterCodeVersions'
      - $ref: '#/components/parameters/environment'
      - $ref: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/clusterVersion'
      x-ms-examples:
        Get cluster version by environment:
          $ref: ./examples/ClusterVersionsGetByEnvironment_example.json
      tags:
      - ClusterVersion
      responses:
        '200':
          description: The operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterCodeVersionsListResult'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/clusterVersions:
    get:
      operationId: ClusterVersions_List
      summary: Gets the list of Service Fabric cluster code versions available for the…
      description: Gets all available code versions for Service Fabric cluster resources by location.
      parameters:
      - $ref: '#/components/parameters/locationForClusterCodeVersions'
      - $ref: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/subscriptionId'
      x-ms-examples:
        List cluster versions:
          $ref: ./examples/ClusterVersionsList_example.json
      tags:
      - ClusterVersion
      responses:
        '200':
          description: The operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterCodeVersionsListResult'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
  ? /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/clusterVersions
  : get:
      operationId: ClusterVersions_ListByEnvironment
      summary: Gets the list of Service Fabric cluster code versions available for the…
      description: Gets all available code versions for Service Fabric cluster resources by environment.
      parameters:
      - $ref: '#/components/parameters/locationForClusterCodeVersions'
      - $ref: '#/components/parameters/environment'
      - $ref: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/subscriptionId'
      x-ms-examples:
        List cluster versions by environment:
          $ref: ./examples/ClusterVersionsListByEnvironment.json
      tags:
      - ClusterVersion
      responses:
        '200':
          description: The operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterCodeVersionsListResult'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
components:
  parameters:
    locationForClusterCodeVersions:
      name: location
      in: path
      description: The location for the cluster code versions. This is different from cluster location.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    clusterVersion:
      name: clusterVersion
      in: path
      description: The cluster code version.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    api-version:
      name: api-version
      in: query
      description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification.
      required: true
      x-ms-parameter-location: client
      schema:
        type: string
        enum:
        - '2021-06-01'
        default: '2021-06-01'
    subscriptionId:
      name: subscriptionId
      in: path
      description: The customer subscription identifier.
      required: true
      x-ms-parameter-location: client
      schema:
        type: string
    environment:
      name: environment
      in: path
      description: The operating system of the cluster. The default means all.
      required: true
      x-ms-enum:
        name: ClusterVersionsEnvironment
        modelAsString: true
      x-ms-parameter-location: method
      schema:
        type: string
        enum:
        - Windows
        - Linux
  schemas:
    ErrorModelError:
      type: object
      properties:
        code:
          type: string
          description: The error code.
        message:
          type: string
          description: The error message.
      description: The error details.
    ClusterEnvironment:
      type: string
      description: Cluster operating system, the default will be Windows
      enum:
      - Windows
      - Linux
    ClusterCodeVersionsResult:
      type: object
      properties:
        id:
          type: string
          description: The identification of the result
        name:
          type: string
          description: The name of the result
        type:
          type: string
          description: The result resource type
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/ClusterVersionDetails'
      description: The result of the Service Fabric runtime versions
    ClusterVersionDetails:
      type: object
      properties:
        codeVersion:
          type: string
          description: The Service Fabric runtime version of the cluster.
        supportExpiryUtc:
          type: string
          description: The date of expiry of support of the version.
        environment:
          $ref: '#/components/schemas/ClusterEnvironment'
          description: Indicates if this version is for Windows or Linux operating system.
      description: The detail of the Service Fabric runtime version result
    ErrorModel:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorModelError'
      description: The structure of the error.
    ClusterCodeVersionsListResult:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/ClusterCodeVersionsResult'
        nextLink:
          type: string
          description: The URL to use for getting the next set of results.
      description: The list results of the Service Fabric runtime versions.
  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