Services - List

Serviço:

Service Fabric

Versão da API:

2023-11-01-preview

Obtém a lista de recursos de serviço criados no recurso de aplicação Service Fabric especificado.
Obtém todos os recursos de serviço criados ou em processo de criação no recurso de aplicação Service Fabric.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
applicationName	path	True	string	O nome do recurso de aplicativo.
clusterName	path	True	string	O nome do recurso de cluster.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	ServiceResourceList	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorModel	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

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 service resources

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

200

{
  "nextLink": "http://examplelink.com",
  "value": [
    {
      "name": "myCluster",
      "type": "services",
      "etag": "W/\"636462502183671257\"",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService",
      "location": "eastus",
      "properties": {
        "instanceCount": 1,
        "partitionDescription": {
          "partitionScheme": "Singleton"
        },
        "provisioningState": "Updating",
        "serviceKind": "Stateless",
        "serviceLoadMetrics": [
          {
            "name": "metric1",
            "weight": "Low"
          }
        ],
        "servicePackageActivationMode": "SharedProcess",
        "serviceTypeName": "myServiceType"
      },
      "tags": {}
    }
  ]
}

Definições

Nome	Description
ArmServicePackageActivationMode	O modo de ativação do pacote de serviço
createdByType	O tipo de identidade que criou o recurso.
ErrorModel	A estrutura do erro.
ErrorModelError	Os detalhes do erro.
MoveCost	Especifica o custo de movimentação do serviço.
NamedPartitionSchemeDescription	Descreve o esquema de partição nomeado do serviço.
PartitionScheme	Enumera as maneiras pelas quais um serviço pode ser particionado.
ServiceCorrelationDescription	Cria uma correlação específica entre serviços.
ServiceCorrelationScheme	O esquema de correlação de serviço.
ServiceKind	O tipo de serviço (sem estado ou com estado).
ServiceLoadMetricDescription	Especifica uma métrica para balancear a carga de um serviço durante o runtime.
ServiceLoadMetricWeight	Determina o peso da métrica em relação às outras métricas configuradas para esse serviço. Durante a execução, se duas métricas entrarem em conflito, o Cluster Resource Manager prefere a métrica com maior peso.
ServiceResource	O recurso de serviço.
ServiceResourceList	A lista de recursos de serviço.
SingletonPartitionSchemeDescription	Descreve o esquema de partição de um serviço particionado por singleton ou não particionado.
StatefulServiceProperties	As propriedades de um recurso de serviço com estado.
StatelessServiceProperties	As propriedades de um recurso de serviço sem estado.
systemData	Metadados relativos à criação e última modificação do recurso.
UniformInt64RangePartitionSchemeDescription	Descreve um esquema de particionamento em que um intervalo de inteiros é alocado uniformemente em várias partições.

ArmServicePackageActivationMode

Enumeração

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

Valor	Description
SharedProcess	Indica que o modo de ativação do pacote de aplicação usará o processo compartilhado.
ExclusiveProcess	Indica que o modo de ativação do pacote de aplicação usará processo exclusivo.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

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.

MoveCost

Enumeração

Especifica o custo de movimentação do serviço.

Valor	Description
Zero	Custo zero de movimento. Esse valor é zero.
Low	Especifica o custo de mudança do serviço como Baixo. O valor é 1.
Medium	Especifica o custo de mudança do serviço como Médio. O valor é 2.
High	Especifica o custo de mudança do serviço como Alto. O valor é 3.

NamedPartitionSchemeDescription

Objeto

Descreve o esquema de partição nomeado do serviço.

Nome	Tipo	Description
count	integer (int32)	O número de partições.
names	string[]	Matriz de tamanho especificada pelo parâmetro 'count', para os nomes das partições.
partitionScheme	string: Named	Especifica como o serviço é particionado.

PartitionScheme

Enumeração

Enumera as maneiras pelas quais um serviço pode ser particionado.

Valor	Description
Invalid	Indica que o tipo de partição é inválido. Todas as enumerações Service Fabric têm o tipo inválido. O valor é zero.
Singleton	Indica que a partição é baseada em nomes de string, e é um objeto SingletonPartitionSchemeDescription, o valor é 1.
UniformInt64Range	Indica que a partição é baseada em intervalos de chaves Int64, e é um objeto UniformInt64RangePartitionSchemeDescription. O valor é 2.
Named	Indica que a partição é baseada em nomes de string, e é um objeto NamedPartitionSchemeDescription. O valor é 3

ServiceCorrelationDescription

Objeto

Cria uma correlação específica entre serviços.

Nome	Tipo	Description
scheme	ServiceCorrelationScheme	O ServiceCorrelationScheme que descreve a relação entre esse serviço e o serviço especificado por meio do ServiceName.
serviceName	string	O nome completo do serviço com esquema URI 'fabric:'.

ServiceCorrelationScheme

Enumeração

O esquema de correlação de serviço.

Valor	Description
Invalid	Um esquema de correlação inválido. Não pode ser usado. O valor é zero.
Affinity	Indica que esse serviço tem uma relação de afinidade com outro serviço. Caso seja para compatibilidade retroativa, considere preferir as opções Aligned ou NonAlignedAffinity. O valor é 1.
AlignedAffinity	A afinidade alinhada garante que os primários das partições dos serviços afinitizados estejam colocados nos mesmos nós. Esse é o padrão e é o mesmo que selecionar o esquema Affinity. O valor é 2.
NonAlignedAffinity	A afinidade Não Alinhada garante que todas as réplicas de cada serviço serão colocadas nos mesmos nós. Ao contrário da Afinidade Alinhada, isso não garante que réplicas de uma função específica sejam agrupadas. O valor é 3.

ServiceKind

Enumeração

O tipo de serviço (sem estado ou com estado).

Valor	Description
Invalid	Indica que o tipo de serviço é inválido. Todas as enumerações Service Fabric têm o tipo inválido. O valor é zero.
Stateless	Não utiliza Service Fabric para tornar seu estado altamente disponível ou confiável. O valor é 1.
Stateful	Utiliza o Service Fabric para tornar seu estado ou parte dele altamente disponível e confiável. O valor é 2.

ServiceLoadMetricDescription

Objeto

Especifica uma métrica para balancear a carga de um serviço durante o runtime.

Nome	Tipo	Description
defaultLoad	integer (int32)	Usado somente para serviços sem estado. A quantidade padrão de carga, como um número, que esse serviço cria para essa métrica.
name	string	O nome da métrica. Se o serviço optar por relatar a carga durante o runtime, o nome da métrica de carga deverá corresponder exatamente ao nome especificado em Nome. Observe que os nomes de métrica diferenciam maiúsculas de minúsculas.
primaryDefaultLoad	integer (int32)	Usado somente para serviços com estado. A quantidade padrão de carga, como um número, que esse serviço cria para essa métrica quando é uma réplica primária.
secondaryDefaultLoad	integer (int32)	Usado somente para serviços com estado. A quantidade padrão de carga, como um número, que esse serviço cria para essa métrica quando é uma réplica secundária.
weight	ServiceLoadMetricWeight	O peso relativo da métrica de carga do serviço, em comparação com outras métricas configuradas para esse serviço, como um número.

ServiceLoadMetricWeight

Enumeração

Determina o peso da métrica em relação às outras métricas configuradas para esse serviço. Durante a execução, se duas métricas entrarem em conflito, o Cluster Resource Manager prefere a métrica com maior peso.

Valor	Description
Zero	Desativa o balanceamento de recursos para essa métrica. Esse valor é zero.
Low	Especifica o peso métrico da carga de serviço como Baixo. O valor é 1.
Medium	Especifica o peso métrico da carga de serviço como Médio. O valor é 2.
High	Especifica o peso métrico da carga de serviço como Alto. O valor é 3.

ServiceResource

Objeto

O recurso de serviço.

Nome	Tipo	Description
etag	string	Azure resource etag.
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Ele será preterido na Nova API, o local do recurso depende do recurso pai.
name	string	O nome do recurso
properties	ServiceResourceProperties: StatefulServiceProperties StatelessServiceProperties	As propriedades do recurso de serviço.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Azure resource tags.
type	string	O tipo do recurso. Por exemplo, "Microsoft. Compute/virtualMachines" ou "Microsoft. ContasArmazenamento/Armazenamento"

ServiceResourceList

Objeto

A lista de recursos de serviço.

Nome	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	ServiceResource[]	Os itens ServiceResource nesta página

SingletonPartitionSchemeDescription

Objeto

Descreve o esquema de partição de um serviço particionado por singleton ou não particionado.

Nome	Tipo	Description
partitionScheme	string: Singleton	Especifica como o serviço é particionado.

StatefulServiceProperties

Objeto

As propriedades de um recurso de serviço com estado.

Nome	Tipo	Description
correlationScheme	ServiceCorrelationDescription[]	Uma lista que descreve a correlação do serviço com outros serviços.
defaultMoveCost	MoveCost	Especifica o custo de movimentação do serviço.
hasPersistedState	boolean	Um sinalizador que indica se esse é um serviço persistente que armazena estados no disco local. Se for, o valor dessa propriedade será verdadeiro, se não for falso.
minReplicaSetSize	integer (int32) minimum: 1	O tamanho mínimo do conjunto de réplicas como um número.
partitionDescription	PartitionSchemeDescription: NamedPartitionSchemeDescription SingletonPartitionSchemeDescription UniformInt64RangePartitionSchemeDescription	Descreve como o serviço é particionado.
placementConstraints	string	As restrições de posicionamento como uma cadeia de caracteres. Restrições de posicionamento são expressões boolianas em propriedades de nó e permitem restringir um serviço a nós específicos com base nos requisitos de serviço. Por exemplo, para colocar um serviço em nós em que NodeType é azul, especifique o seguinte: "NodeColor == blue)".
provisioningState	string	O estado de implantação ou provisionamento atual, que aparece apenas na resposta
quorumLossWaitDuration	string (date-time)	A duração máxima para a qual uma partição pode estar em um estado de perda de quorum, representada no formato ISO 8601 (hh:mm:ss.s).
replicaRestartWaitDuration	string (date-time)	A duração entre quando uma réplica fica inoperante e quando uma nova réplica é criada, representada no formato ISO 8601 (hh:mm:ss.s).
serviceDnsName	string	Nome Dns usado para o serviço. Se isso for especificado, o nome DNS poderá ser usado para retornar os endereços IP dos pontos de extremidade de serviço para protocolos de camada de aplicativo (por exemplo, HTTP). Ao atualizar serviceDnsName, o nome antigo pode ser temporariamente resolvível. No entanto, conte com o novo nome. Ao remover serviceDnsName, o nome removido pode ser temporariamente resolvível. Não dependa do nome ser irrecupeável.
serviceKind	string: Stateful	O tipo de serviço (sem estado ou com estado).
serviceLoadMetrics	ServiceLoadMetricDescription[]	As métricas de carga de serviço são fornecidas como uma matriz de objetos ServiceLoadMetricDescription.
servicePackageActivationMode	ArmServicePackageActivationMode	O modo de ativação do pacote de serviço
servicePlacementPolicies	ServicePlacementPolicyDescription[]	Uma lista que descreve a correlação do serviço com outros serviços.
serviceTypeName	string	O nome do tipo de serviço
standByReplicaKeepDuration	string (date-time)	A definição de quanto tempo as réplicas StandBy devem ser mantidas antes de serem removidas, representadas no formato ISO 8601 (hh:mm:ss.s).
targetReplicaSetSize	integer (int32) minimum: 1	O tamanho do conjunto de réplicas de destino como um número.

StatelessServiceProperties

Objeto

As propriedades de um recurso de serviço sem estado.

Nome	Tipo	Description
correlationScheme	ServiceCorrelationDescription[]	Uma lista que descreve a correlação do serviço com outros serviços.
defaultMoveCost	MoveCost	Especifica o custo de movimentação do serviço.
instanceCloseDelayDuration	string	A duração do atraso do recurso RequestDrain garante que o ponto de extremidade anunciado pela instância sem estado seja removido antes que o atraso seja iniciado antes de fechar a instância. Esse atraso permite que as requisições existentes sejam drenadas de forma natural antes que a instância realmente caia (https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-application-upgrade-advanced#avoid-connection-drops-during-stateless-service-planned-downtime-preview). Ele é representado no formato ISO 8601 (hh:mm:ss.s).
instanceCount	integer (int32) minimum: -1	A contagem de instâncias.
minInstanceCount	integer (int32)	MinInstanceCount é o número mínimo de instâncias que devem estar em conformidade com a verificação de segurança de EnsureAvailability durante operações como atualizar ou desativar nó. O número real usado é max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Observe que, se InstanceCount for definido como -1, durante a computação MinInstanceCount -1 será convertido primeiro no número de nós nos quais as instâncias têm permissão para serem colocadas de acordo com as restrições de posicionamento no serviço.
minInstancePercentage	string (byte)	MinInstancePercentage é o percentual mínimo de InstanceCount que deve estar em conformidade com a verificação de segurança EnsureAvailability durante operações como atualizar ou desativar nó. O número real usado é max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Observe que, se InstanceCount for definido como -1, durante a computação MinInstancePercentage, -1 será convertido primeiro no número de nós nos quais as instâncias têm permissão para serem colocadas de acordo com as restrições de posicionamento no serviço.
partitionDescription	PartitionSchemeDescription: NamedPartitionSchemeDescription SingletonPartitionSchemeDescription UniformInt64RangePartitionSchemeDescription	Descreve como o serviço é particionado.
placementConstraints	string	As restrições de posicionamento como uma cadeia de caracteres. Restrições de posicionamento são expressões boolianas em propriedades de nó e permitem restringir um serviço a nós específicos com base nos requisitos de serviço. Por exemplo, para colocar um serviço em nós em que NodeType é azul, especifique o seguinte: "NodeColor == blue)".
provisioningState	string	O estado de implantação ou provisionamento atual, que aparece apenas na resposta
serviceDnsName	string	Nome Dns usado para o serviço. Se isso for especificado, o nome DNS poderá ser usado para retornar os endereços IP dos pontos de extremidade de serviço para protocolos de camada de aplicativo (por exemplo, HTTP). Ao atualizar serviceDnsName, o nome antigo pode ser temporariamente resolvível. No entanto, conte com o novo nome. Ao remover serviceDnsName, o nome removido pode ser temporariamente resolvível. Não dependa do nome ser irrecupeável.
serviceKind	string: Stateless	O tipo de serviço (sem estado ou com estado).
serviceLoadMetrics	ServiceLoadMetricDescription[]	As métricas de carga de serviço são fornecidas como uma matriz de objetos ServiceLoadMetricDescription.
servicePackageActivationMode	ArmServicePackageActivationMode	O modo de ativação do pacote de serviço
servicePlacementPolicies	ServicePlacementPolicyDescription[]	Uma lista que descreve a correlação do serviço com outros serviços.
serviceTypeName	string	O nome do tipo de serviço

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	createdByType	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	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UniformInt64RangePartitionSchemeDescription

Objeto

Descreve um esquema de particionamento em que um intervalo de inteiros é alocado uniformemente em várias partições.

Nome	Tipo	Description
count	integer (int32)	O número de partições.
highKey	string	String indicando o limite superior do intervalo de chaves de partição que deve ser dividido entre a 'contagem' da partição
lowKey	string	String indicando o limite inferior do intervalo de chaves de partição que deve ser dividido entre a 'contagem' da partição
partitionScheme	string: UniformInt64Range	Especifica como o serviço é particionado.