Cluster Versions - List

Reference

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	The location parameter.
subscriptionId	path	True	string	The customer subscription identifier.
api-version	query	True	string	The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2023-11-01-preview" for this specification.

Responses

Name	Type	Description
200 OK	ClusterCodeVersionsListResult	The operation completed successfully.
Other Status Codes	ErrorModel	The detailed 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

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.servicefabric import ServiceFabricManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicefabric
# USAGE
    python cluster_versions_list_example.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ServiceFabricManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.cluster_versions.list(
        location="eastus",
    )
    print(response)


# x-ms-original-file: specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/examples/ClusterVersionsList_example.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ServiceFabric;
using Azure.ResourceManager.ServiceFabric.Models;

// Generated from example definition: specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/examples/ClusterVersionsList_example.json
// this example is just showing the usage of "ClusterVersions_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
AzureLocation location = new AzureLocation("eastus");
await foreach (ClusterCodeVersionsResult item in subscriptionResource.GetClusterVersionsAsync(location))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

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

Definitions

Name	Description
ClusterCodeVersionsListResult	The list results of the Service Fabric runtime versions.
ClusterCodeVersionsResult	The result of the Service Fabric runtime versions
ClusterEnvironment	Cluster operating system, the default will be Windows
ErrorModel	The structure of the error.
ErrorModelError	The error details.

ClusterCodeVersionsListResult

The list results of the Service Fabric runtime versions.

Name	Type	Description
nextLink	string	The URL to use for getting the next set of results.
value	ClusterCodeVersionsResult[]	The result of the Service Fabric runtime versions

ClusterCodeVersionsResult

The result of the Service Fabric runtime versions

Name	Type	Description
id	string	The identification of the result
name	string	The name of the result
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.
type	string	The result resource type

ClusterEnvironment

Cluster operating system, the default will be Windows

Name	Type	Description
Linux	string
Windows	string

ErrorModel

The structure of the error.

Name	Type	Description
error	ErrorModelError	The error details.

ErrorModelError

The error details.

Name	Type	Description
code	string	The error code.
message	string	The error message.