Cluster Versions - List

Service:

Service Fabric

API Version:

2023-11-01-preview

Gets the list of Service Fabric cluster code versions available for the specified location.
Gets all available code versions for Service Fabric cluster resources by location.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/clusterVersions?api-version=2023-11-01-preview

URI Parameters

Name	In	Required	Type	Description
location	path	True	string minLength: 1	The name of Azure region.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ClusterCodeVersionsListResult	The request has succeeded.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List cluster versions

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/clusterVersions?api-version=2023-11-01-preview

Sample response

Status code:

200

{
  "value": [
    {
      "name": "6.1.480.9494",
      "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions",
      "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494",
      "properties": {
        "codeVersion": "6.1.480.9494",
        "environment": "Windows",
        "supportExpiryUtc": "2018-06-15T23:59:59.9999999"
      }
    },
    {
      "name": "6.1.187.1",
      "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions",
      "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Linux/clusterVersions/6.1.187.1",
      "properties": {
        "codeVersion": "6.1.187.1",
        "environment": "Linux",
        "supportExpiryUtc": "2018-06-15T23:59:59.9999999"
      }
    }
  ]
}

Definitions

Name	Description
ClusterCodeVersionsListResult	The response of a ClusterCodeVersions list operation.
ClusterCodeVersionsResult	The result of the Service Fabric runtime versions
ClusterEnvironment	Cluster operating system, the default will be Windows
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
systemData	Metadata pertaining to creation and last modification of the resource.

ClusterCodeVersionsListResult

Object

The response of a ClusterCodeVersions list operation.

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	ClusterCodeVersionsResult[]	The ClusterCodeVersions items on this page

ClusterCodeVersionsResult

Object

The result of the Service Fabric runtime versions

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.codeVersion	string	The Service Fabric runtime version of the cluster.
properties.environment	ClusterEnvironment	Indicates if this version is for Windows or Linux operating system.
properties.supportExpiryUtc	string	The date of expiry of support of the version.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ClusterEnvironment

Enumeration

Cluster operating system, the default will be Windows

Value	Description
Windows	Windows operating system
Linux	Linux operating system

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.