Applications - List

Service:: Service Fabric

API Version:: 2023-11-01-preview

Gets the list of application resources created in the specified Service Fabric cluster resource.
Gets all application 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}/applications?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	ApplicationResourceList	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 resources

Sample request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications?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 application_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.applications.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/ApplicationListOperation_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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ServiceFabric.Models;
using Azure.ResourceManager.ServiceFabric;

// Generated from example definition: specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/examples/ApplicationListOperation_example.json
// this example is just showing the usage of "Applications_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 ServiceFabricApplicationResource
ServiceFabricApplicationCollection collection = serviceFabricCluster.GetServiceFabricApplications();

// invoke the operation and iterate over the result
await foreach (ServiceFabricApplicationResource 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
    ServiceFabricApplicationData 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": "applications",
      "location": "eastus",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp",
      "name": "myCluster",
      "tags": {},
      "etag": "W/\"636462502180261858\"",
      "properties": {
        "provisioningState": "Updating",
        "typeName": "myAppType",
        "typeVersion": "1.0",
        "removeApplicationCapacity": false,
        "metrics": [
          {
            "name": "metric1",
            "reservationCapacity": 1,
            "maximumCapacity": 3,
            "totalApplicationCapacity": 5
          }
        ]
      }
    }
  ],
  "nextLink": ""
}

Definitions

Name	Description
ApplicationMetricDescription	Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.
ApplicationResource	The application resource.
ApplicationResourceList	The list of application resources.
ApplicationUpgradePolicy	Describes the policy for a monitored application upgrade.
ApplicationUserAssignedIdentity
ArmApplicationHealthPolicy	Defines a health policy used to evaluate the health of an application or one of its children entities.
ArmRollingUpgradeMonitoringPolicy	The policy used for monitoring the application upgrade
ArmServiceTypeHealthPolicy	Represents the health policy used to evaluate the health of services belonging to a service type.
ArmUpgradeFailureAction	The activation Mode of the service package
ErrorModel	The structure of the error.
ErrorModelError	The error details.
ManagedIdentity	Describes the managed identities for an Azure resource.
ManagedIdentityType	The type of managed identity for the resource.
RollingUpgradeMode	The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored.
SystemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity

ApplicationMetricDescription

Object

Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.

Name	Type	Description
maximumCapacity	integer (int64)	The maximum node capacity for Service Fabric application. This is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value. If set to zero, capacity for this metric is unlimited on each node. When creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity. When updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.
name	string	The name of the metric.
reservationCapacity	integer (int64)	The node reservation capacity for Service Fabric application. This is the amount of load which is reserved on nodes which have instances of this application. If MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application. If set to zero, no capacity is reserved for this metric. When setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric.
totalApplicationCapacity	integer (int64)	The total metric capacity for Service Fabric application. This is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value. When creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.

ApplicationResource

Object

The application resource.

Name	Type	Default value	Description
etag	string		Azure resource etag.
id	string		Azure resource identifier.
identity	ManagedIdentity		Describes the managed identities for an Azure resource.
location	string		It will be deprecated in New API, resource location depends on the parent resource.
name	string		Azure resource name.
properties.managedIdentities	ApplicationUserAssignedIdentity[]		List of user assigned identities for the application, each mapped to a friendly name.
properties.maximumNodes	integer (int64) minimum: 0	0	The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node.
properties.metrics	ApplicationMetricDescription[]		List of application capacity metric description.
properties.minimumNodes	integer (int64) minimum: 0		The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.
properties.parameters	object		List of application parameters with overridden values from their default values specified in the application manifest.
properties.provisioningState	string		The current deployment or provisioning state, which only appears in the response
properties.removeApplicationCapacity	boolean		Remove the current application capacity settings.
properties.typeName	string		The application type name as defined in the application manifest.
properties.typeVersion	string		The version of the application type as defined in the application manifest.
properties.upgradePolicy	ApplicationUpgradePolicy		Describes the policy for a monitored application upgrade.
systemData	SystemData		Metadata pertaining to creation and last modification of the resource.
tags	object		Azure resource tags.
type	string		Azure resource type.

ApplicationResourceList

Object

The list of application resources.

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

ApplicationUpgradePolicy

Object

Describes the policy for a monitored application upgrade.

Name	Type	Default value	Description
applicationHealthPolicy	ArmApplicationHealthPolicy		Defines a health policy used to evaluate the health of an application or one of its children entities.
forceRestart	boolean	False	If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
recreateApplication	boolean		Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed and it will result in availability loss.
rollingUpgradeMonitoringPolicy	ArmRollingUpgradeMonitoringPolicy		The policy used for monitoring the application upgrade
upgradeMode	RollingUpgradeMode	Monitored	The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored.
upgradeReplicaSetCheckTimeout	string		The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).

ApplicationUserAssignedIdentity

Object

Name	Type	Description
name	string	The friendly name of user assigned identity.
principalId	string	The principal id of user assigned identity.

ArmApplicationHealthPolicy

Object

Defines a health policy used to evaluate the health of an application or one of its children entities.

Name	Type	Default value	Description
considerWarningAsError	boolean	False	Indicates whether warnings are treated with the same severity as errors.
defaultServiceTypeHealthPolicy	ArmServiceTypeHealthPolicy		The health policy used by default to evaluate the health of a service type.
maxPercentUnhealthyDeployedApplications	integer (int32)	0	The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.
serviceTypeHealthPolicyMap	<string, ArmServiceTypeHealthPolicy>		The map with service type health policy per service type name. The map is empty by default.

ArmRollingUpgradeMonitoringPolicy

Object

The policy used for monitoring the application upgrade

Name	Type	Default value	Description
failureAction	ArmUpgradeFailureAction		The activation Mode of the service package
healthCheckRetryTimeout	string	PT0H10M0S	The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
healthCheckStableDuration	string	PT0H2M0S	The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
healthCheckWaitDuration	string	0	The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
upgradeDomainTimeout	string	P10675199DT02H48M05.4775807S	The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
upgradeTimeout	string	P10675199DT02H48M05.4775807S	The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

ArmServiceTypeHealthPolicy

Object

Represents the health policy used to evaluate the health of services belonging to a service type.

Name	Type	Description
maxPercentUnhealthyPartitionsPerService	integer (int32) minimum: 0 maximum: 100	The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error.
maxPercentUnhealthyReplicasPerPartition	integer (int32) minimum: 0 maximum: 100	The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error.
maxPercentUnhealthyServices	integer (int32) minimum: 0 maximum: 100	The maximum percentage of services allowed to be unhealthy before your application is considered in error.

ArmUpgradeFailureAction

Enumeration

The activation Mode of the service package

Value	Description
Rollback	Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails.
Manual	Indicates that a manual repair will need to be performed by the administrator if the upgrade fails. Service Fabric will not proceed to the next upgrade domain automatically.

ErrorModel

Object

The structure of the error.

Name	Type	Description
error	ErrorModelError	The error details.

ErrorModelError

Object

The error details.

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

ManagedIdentity

Object

Describes the managed identities for an Azure resource.

Name	Type	Description
principalId	string	The principal id of the managed identity. This property will only be provided for a system assigned identity.
tenantId	string	The tenant id of the managed identity. This property will only be provided for a system assigned identity.
type	ManagedIdentityType	The type of managed identity for the resource.
userAssignedIdentities	<string, UserAssignedIdentity>	The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ManagedIdentityType

Enumeration

The type of managed identity for the resource.

Value	Description
SystemAssigned	Indicates that system assigned identity is associated with the resource.
UserAssigned	Indicates that user assigned identity is associated with the resource.
SystemAssigned, UserAssigned	Indicates that both system assigned and user assigned identity are associated with the resource.
None	Indicates that no identity is associated with the resource.

RollingUpgradeMode

Enumeration

The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored.

Value	Description
Invalid	Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
UnmonitoredAuto	The upgrade will proceed automatically without performing any health monitoring. The value is 1
UnmonitoredManual	The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2
Monitored	The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3

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	string	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	string	The type of identity that last modified the resource.

UserAssignedIdentity

Object

Name	Type	Description
clientId	string	The client id of user assigned identity.
principalId	string	The principal id of user assigned identity.

Share via

Applications - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Get a list of application resources

Sample request

Sample response

Definitions

ApplicationMetricDescription

ApplicationResource

ApplicationResourceList

ApplicationUpgradePolicy

ApplicationUserAssignedIdentity

ArmApplicationHealthPolicy

ArmRollingUpgradeMonitoringPolicy

ArmServiceTypeHealthPolicy

ArmUpgradeFailureAction

ErrorModel

ErrorModelError

ManagedIdentity

ManagedIdentityType

RollingUpgradeMode

SystemData

UserAssignedIdentity