Application Types - List

Service:

Service Fabric

API Version:

2023-11-01-preview

Gets the list of application type name resources created in the specified Service Fabric cluster resource.
Gets all application type name resources created or in the process of being created in the Service Fabric cluster resource.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes?api-version=2023-11-01-preview

URI Parameters

Name	In	Required	Type	Description
clusterName	path	True	string	The name of the cluster resource.
resourceGroupName	path	True	string	The name of the resource group.
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	ApplicationTypeResourceList	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

Get a list of application type name resources

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes?api-version=2023-11-01-preview

Python

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicefabric
# USAGE
    python application_type_name_list_operation_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.application_types.list(
        resource_group_name="resRg",
        cluster_name="myCluster",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/examples/ApplicationTypeNameListOperation_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

dotnet

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

// Generated from example definition: specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/examples/ApplicationTypeNameListOperation_example.json
// this example is just showing the usage of "ApplicationTypes_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 ServiceFabricClusterResource created on azure
// for more information of creating ServiceFabricClusterResource, please refer to the document of ServiceFabricClusterResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "resRg";
string clusterName = "myCluster";
ResourceIdentifier serviceFabricClusterResourceId = ServiceFabricClusterResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, clusterName);
ServiceFabricClusterResource serviceFabricCluster = client.GetServiceFabricClusterResource(serviceFabricClusterResourceId);

// get the collection of this ServiceFabricApplicationTypeResource
ServiceFabricApplicationTypeCollection collection = serviceFabricCluster.GetServiceFabricApplicationTypes();

// invoke the operation and iterate over the result
await foreach (ServiceFabricApplicationTypeResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ServiceFabricApplicationTypeData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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": [
    {
      "type": "applicationTypes",
      "location": "eastus",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType",
      "name": "myCluster",
      "tags": {},
      "etag": "W/\"636462502174844831\"",
      "properties": {
        "provisioningState": "Succeeded"
      }
    }
  ],
  "nextLink": ""
}

Definitions

Name	Description
ApplicationTypeResource	The application type name resource
ApplicationTypeResourceList	The list of application type names.
ErrorModel	The structure of the error.
ErrorModelError	The error details.
SystemData	Metadata pertaining to creation and last modification of the resource.

ApplicationTypeResource

The application type name resource

Name	Type	Description
etag	string	Azure resource etag.
id	string	Azure resource identifier.
location	string	It will be deprecated in New API, resource location depends on the parent resource.
name	string	Azure resource name.
properties.provisioningState	string	The current deployment or provisioning state, which only appears in the response.
systemData	SystemData	Metadata pertaining to creation and last modification of the resource.
tags	object	Azure resource tags.
type	string	Azure resource type.

ApplicationTypeResourceList

The list of application type names.

Name	Type	Description
nextLink	string	URL to get the next set of application type list results if there are any.
value	ApplicationTypeResource[]	The application type name resource

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.

SystemData

Metadata pertaining to creation and last modification of the resource.

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