Applications - List

Referência

Serviço:: Service Fabric

Versão da API:: 2023-11-01-preview

Obtém a lista de recursos de aplicativo criados no recurso de cluster do Service Fabric especificado.
Obtém todos os recursos de aplicativo criados ou no processo de criação no recurso de cluster do Service Fabric.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
clusterName	path	True	string	O nome do recurso de cluster.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	O identificador de assinatura do cliente.
api-version	query	True	string	A versão da API do provedor de recursos do Service Fabric. Esse é um parâmetro necessário e seu valor deve ser "2023-11-01-preview" para esta especificação.

Respostas

Nome	Tipo	Description
200 OK	ApplicationResourceList	A operação foi concluída com êxito.
Other Status Codes	ErrorModel	A resposta de erro detalhada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get a list of application resources

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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": ""
}

Definições

Nome	Description
ApplicationMetricDescription	Descreve as informações de capacidade de uma métrica de balanceamento de recursos personalizada. Isso pode ser usado para limitar o consumo total dessa métrica pelos serviços deste aplicativo.
ApplicationResource	O recurso do aplicativo.
ApplicationResourceList	A lista de recursos do aplicativo.
ApplicationUpgradePolicy	Descreve a política de uma atualização de aplicativo monitorada.
ApplicationUserAssignedIdentity
ArmApplicationHealthPolicy	Define uma política de integridade usada para avaliar a integridade de um aplicativo ou de uma de suas entidades filho.
ArmRollingUpgradeMonitoringPolicy	A política usada para monitorar a atualização do aplicativo
ArmServiceTypeHealthPolicy	Representa a política de integridade usada para avaliar a integridade dos serviços pertencentes a um tipo de serviço.
ArmUpgradeFailureAction	O modo de ativação do pacote de serviço
ErrorModel	A estrutura do erro.
ErrorModelError	Os detalhes do erro.
ManagedIdentity	Descreve as identidades gerenciadas de um recurso do Azure.
ManagedIdentityType	O tipo de identidade gerenciada para o recurso.
RollingUpgradeMode	O modo usado para monitorar a integridade durante uma atualização sem interrupção. Os valores são UnmonitoredAuto, UnmonitoredManual e Monitored.
SystemData	Metadados relativos à criação e última modificação do recurso.
UserAssignedIdentity

ApplicationMetricDescription

Objeto

Descreve as informações de capacidade de uma métrica de balanceamento de recursos personalizada. Isso pode ser usado para limitar o consumo total dessa métrica pelos serviços deste aplicativo.

Nome	Tipo	Description
maximumCapacity	integer (int64)	A capacidade máxima do nó para o aplicativo do Service Fabric. Essa é a carga máxima para uma instância desse aplicativo em um único nó. Mesmo que a capacidade do nó seja maior que esse valor, o Service Fabric limitará a carga total de serviços dentro do aplicativo em cada nó a esse valor. Se definido como zero, a capacidade dessa métrica será ilimitada em cada nó. Ao criar um novo aplicativo com a capacidade do aplicativo definida, o produto de MaximumNodes e esse valor sempre devem ser menores ou iguais a TotalApplicationCapacity. Ao atualizar o aplicativo existente com a capacidade do aplicativo, o produto de MaximumNodes e esse valor sempre devem ser menores ou iguais a TotalApplicationCapacity.
name	string	O nome da métrica.
reservationCapacity	integer (int64)	A capacidade de reserva de nó para o aplicativo Service Fabric. Essa é a quantidade de carga reservada em nós que têm instâncias desse aplicativo. Se MinimumNodes for especificado, o produto desses valores será a capacidade reservada no cluster para o aplicativo. Se definido como zero, nenhuma capacidade será reservada para essa métrica. Ao definir a capacidade do aplicativo ou ao atualizar a capacidade do aplicativo; esse valor deve ser menor ou igual a MaximumCapacity para cada métrica.
totalApplicationCapacity	integer (int64)	A capacidade total da métrica para o aplicativo do Service Fabric. Essa é a capacidade de métrica total para este aplicativo no cluster. O Service Fabric tentará limitar a soma de cargas de serviços dentro do aplicativo a esse valor. Ao criar um novo aplicativo com a capacidade do aplicativo definida, o produto de MaximumNodes e MaximumCapacity sempre deve ser menor ou igual a esse valor.

ApplicationResource

Objeto

O recurso do aplicativo.

Nome	Tipo	Valor padrão	Description
etag	string		Etag de recursos do Azure.
id	string		Identificador de recurso do Azure.
identity	ManagedIdentity		Descreve as identidades gerenciadas de um recurso do Azure.
location	string		Ele será preterido na Nova API, o local do recurso depende do recurso pai.
name	string		Nome do recurso do Azure.
properties.managedIdentities	ApplicationUserAssignedIdentity[]		Lista de identidades atribuídas pelo usuário para o aplicativo, cada uma mapeada para um nome amigável.
properties.maximumNodes	integer (int64) minimum: 0	0	O número máximo de nós em que o Service Fabric reservará capacidade para este aplicativo. Observe que isso não significa que os serviços desse aplicativo serão colocados em todos esses nós. Por padrão, o valor dessa propriedade é zero e significa que os serviços podem ser colocados em qualquer nó.
properties.metrics	ApplicationMetricDescription[]		Lista de descrição da métrica de capacidade do aplicativo.
properties.minimumNodes	integer (int64) minimum: 0		O número mínimo de nós em que o Service Fabric reservará capacidade para este aplicativo. Observe que isso não significa que os serviços desse aplicativo serão colocados em todos esses nós. Se essa propriedade estiver definida como zero, nenhuma capacidade será reservada. O valor dessa propriedade não pode ser maior do que o valor da propriedade MaximumNodes.
properties.parameters	object		Lista de parâmetros de aplicativo com valores substituídos de seus valores padrão especificados no manifesto do aplicativo.
properties.provisioningState	string		O estado de implantação ou provisionamento atual, que aparece apenas na resposta
properties.removeApplicationCapacity	boolean		Remova as configurações atuais de capacidade do aplicativo.
properties.typeName	string		O nome do tipo de aplicativo conforme definido no manifesto do aplicativo.
properties.typeVersion	string		A versão do tipo de aplicativo conforme definido no manifesto do aplicativo.
properties.upgradePolicy	ApplicationUpgradePolicy		Descreve a política de uma atualização de aplicativo monitorada.
systemData	SystemData		Metadados relativos à criação e última modificação do recurso.
tags	object		Marcas de recurso do Azure.
type	string		Tipo de recurso do Azure.

ApplicationResourceList

Objeto

A lista de recursos do aplicativo.

Nome	Tipo	Description
nextLink	string	URL para obter o próximo conjunto de resultados da lista de aplicativos, se houver algum.
value	ApplicationResource[]	O recurso do aplicativo.

ApplicationUpgradePolicy

Objeto

Descreve a política de uma atualização de aplicativo monitorada.

Nome	Tipo	Valor padrão	Description
applicationHealthPolicy	ArmApplicationHealthPolicy		Define uma política de integridade usada para avaliar a integridade de um aplicativo ou de uma de suas entidades filho.
forceRestart	boolean	False	Se for true, os processos serão reiniciados com força durante a atualização mesmo quando a versão do código não tiver sido alterada (a atualização altera apenas a configuração ou os dados).
recreateApplication	boolean		Determina se o aplicativo deve ser recriado na atualização. Se value=true, o restante dos parâmetros de política de atualização não são permitidos e isso resultará em perda de disponibilidade.
rollingUpgradeMonitoringPolicy	ArmRollingUpgradeMonitoringPolicy		A política usada para monitorar a atualização do aplicativo
upgradeMode	RollingUpgradeMode	Monitored	O modo usado para monitorar a integridade durante uma atualização sem interrupção. Os valores são UnmonitoredAuto, UnmonitoredManual e Monitored.
upgradeReplicaSetCheckTimeout	string		O tempo máximo para bloquear o processamento de um domínio de atualização e evitar a perda de disponibilidade quando houver problemas inesperados. Quando esse tempo limite expirar, o processamento do domínio de atualização continuará independentemente dos problemas de perda de disponibilidade. O tempo limite é redefinido no início de cada domínio de atualização. Os valores válidos estão entre 0 e 42949672925 inclusivos. (inteiro sem sinal de 32 bits).

ApplicationUserAssignedIdentity

Objeto

Nome	Tipo	Description
name	string	O nome amigável da identidade atribuída pelo usuário.
principalId	string	A ID principal da identidade atribuída pelo usuário.

ArmApplicationHealthPolicy

Objeto

Define uma política de integridade usada para avaliar a integridade de um aplicativo ou de uma de suas entidades filho.

Nome	Tipo	Valor padrão	Description
considerWarningAsError	boolean	False	Indica se os avisos são tratados com a mesma gravidade que os erros.
defaultServiceTypeHealthPolicy	ArmServiceTypeHealthPolicy		A política de integridade usada por padrão para avaliar a integridade de um tipo de serviço.
maxPercentUnhealthyDeployedApplications	integer (int32)	0	O percentual máximo permitido de aplicativos implantados não íntegros. Os valores permitidos são valores bytes de zero a 100. O percentual representa o percentual máximo tolerado de aplicativos implantados que podem não estar íntegros antes que o aplicativo seja considerado em erro. Isso é calculado dividindo o número de aplicativos implantados não íntegros sobre o número de nós em que o aplicativo está implantado no cluster. A computação é arredondada para tolerar uma falha em um pequeno número de nós. O percentual padrão é zero.
serviceTypeHealthPolicyMap	<string, ArmServiceTypeHealthPolicy>		O mapa com a política de integridade do tipo de serviço por nome de tipo de serviço. O mapa está vazio por padrão.

ArmRollingUpgradeMonitoringPolicy

Objeto

A política usada para monitorar a atualização do aplicativo

Nome	Tipo	Valor padrão	Description
failureAction	ArmUpgradeFailureAction		O modo de ativação do pacote de serviço
healthCheckRetryTimeout	string	PT0H10M0S	A quantidade de tempo para tentar novamente a avaliação de integridade quando o aplicativo ou cluster não estiver íntegro antes de FailureAction ser executado. Ele é interpretado pela primeira vez como uma cadeia de caracteres que representa uma duração ISO 8601. Se isso falhar, ele será interpretado como um número que representa o número total de milissegundos.
healthCheckStableDuration	string	PT0H2M0S	A quantidade de tempo que o aplicativo ou cluster deve permanecer íntegro antes que a atualização prossiga para o próximo domínio de atualização. Ele é interpretado pela primeira vez como uma cadeia de caracteres que representa uma duração ISO 8601. Se isso falhar, ele será interpretado como um número que representa o número total de milissegundos.
healthCheckWaitDuration	string	0	O tempo de espera após a conclusão de um domínio de atualização antes de aplicar políticas de integridade. Ele é interpretado pela primeira vez como uma cadeia de caracteres que representa uma duração ISO 8601. Se isso falhar, ele será interpretado como um número que representa o número total de milissegundos.
upgradeDomainTimeout	string	P10675199DT02H48M05.4775807S	A quantidade de tempo que cada domínio de atualização precisa concluir antes que FailureAction seja executado. Ele é interpretado pela primeira vez como uma cadeia de caracteres que representa uma duração ISO 8601. Se isso falhar, ele será interpretado como um número que representa o número total de milissegundos.
upgradeTimeout	string	P10675199DT02H48M05.4775807S	A quantidade de tempo que a atualização geral precisa ser concluída antes que FailureAction seja executada. Ele é interpretado pela primeira vez como uma cadeia de caracteres que representa uma duração ISO 8601. Se isso falhar, ele será interpretado como um número que representa o número total de milissegundos.

ArmServiceTypeHealthPolicy

Objeto

Representa a política de integridade usada para avaliar a integridade dos serviços pertencentes a um tipo de serviço.

Nome	Tipo	Description
maxPercentUnhealthyPartitionsPerService	integer (int32) minimum: 0 maximum: 100	O percentual máximo de partições por serviço permitido para não estar íntegro antes que seu aplicativo seja considerado em erro.
maxPercentUnhealthyReplicasPerPartition	integer (int32) minimum: 0 maximum: 100	O percentual máximo de réplicas por partição permitido para não estar íntegro antes que seu aplicativo seja considerado em erro.
maxPercentUnhealthyServices	integer (int32) minimum: 0 maximum: 100	O percentual máximo de serviços permitidos para não estar íntegro antes que seu aplicativo seja considerado em erro.

ArmUpgradeFailureAction

Enumeração

O modo de ativação do pacote de serviço

Valor	Description
Manual	Indica que um reparo manual precisará ser executado pelo administrador se a atualização falhar. O Service Fabric não prosseguirá automaticamente para o próximo domínio de atualização.
Rollback	Indica que uma reversão da atualização será executada pelo Service Fabric se a atualização falhar.

ErrorModel

Objeto

A estrutura do erro.

Nome	Tipo	Description
error	ErrorModelError	Os detalhes do erro.

ErrorModelError

Objeto

Os detalhes do erro.

Nome	Tipo	Description
code	string	O código de erro.
message	string	A mensagem de erro.

ManagedIdentity

Objeto

Descreve as identidades gerenciadas de um recurso do Azure.

Nome	Tipo	Description
principalId	string	A ID da entidade de segurança da identidade gerenciada. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.
tenantId	string	A ID do locatário da identidade gerenciada. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.
type	ManagedIdentityType	O tipo de identidade gerenciada para o recurso.
userAssignedIdentities	<string, UserAssignedIdentity>	A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ManagedIdentityType

Enumeração

O tipo de identidade gerenciada para o recurso.

Valor	Description
None	Indica que nenhuma identidade está associada ao recurso.
SystemAssigned	Indica que a identidade atribuída pelo sistema está associada ao recurso.
SystemAssigned, UserAssigned	Indica que a identidade atribuída pelo sistema e pelo usuário está associada ao recurso.
UserAssigned	Indica que a identidade atribuída pelo usuário está associada ao recurso.

RollingUpgradeMode

Enumeração

O modo usado para monitorar a integridade durante uma atualização sem interrupção. Os valores são UnmonitoredAuto, UnmonitoredManual e Monitored.

Valor	Description
Invalid	Indica que o modo de atualização é inválido. Todas as enumerações do Service Fabric têm o tipo inválido. O valor é zero.
Monitored	A atualização será interrompida após a conclusão de cada domínio de atualização e monitorará automaticamente a integridade antes de continuar. O valor é 3
UnmonitoredAuto	A atualização continuará automaticamente sem executar nenhum monitoramento de integridade. O valor é 1
UnmonitoredManual	A atualização será interrompida após a conclusão de cada domínio de atualização, dando a oportunidade de monitorar manualmente a integridade antes de continuar. O valor é 2

SystemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	string	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC).
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	string	O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentity

Objeto

Nome	Tipo	Description
clientId	string	A ID do cliente da identidade atribuída pelo usuário.
principalId	string	A ID principal da identidade atribuída pelo usuário.

Compartilhar via

Applications - List

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Get a list of application resources

Solicitação de exemplo

Resposta de exemplo

Definições

ApplicationMetricDescription

ApplicationResource

ApplicationResourceList

ApplicationUpgradePolicy

ApplicationUserAssignedIdentity

ArmApplicationHealthPolicy

ArmRollingUpgradeMonitoringPolicy

ArmServiceTypeHealthPolicy

ArmUpgradeFailureAction

ErrorModel

ErrorModelError

ManagedIdentity

ManagedIdentityType

RollingUpgradeMode

SystemData

UserAssignedIdentity