---
title: "Lists all the service resources."
method: GET
path: "/Resources/Applications/{applicationResourceName}/Services"
tags: ["MeshServices"]
---

# Lists all the service resources.

`GET /Resources/Applications/{applicationResourceName}/Services`

Gets the information about all services of an application resource. The information include the description and other properties of the Service.

## Path parameters

- `applicationResourceName` string, required

## Query parameters

- `api-version` '6.4-preview', required

## Response `200`

OK

- PagedServiceResourceDescriptionList — The list of service resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
  - `ContinuationToken` string — The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
  - `Items` ServiceResourceDescription[] — One page of the list.
    - `name` string, required — Name of the Service resource.
    - `properties` ServiceResourceProperties, required — Describes properties of a service resource.
      - `osType` 'Linux' | 'Windows', required — The operation system required by the code in service.
      - `codePackages` ContainerCodePackageProperties[], required — Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).
        - `name` string, required — The name of the code package.
        - `image` string, required — The Container image to use.
        - `imageRegistryCredential` ImageRegistryCredential — Image registry credential.
          - `server` string, required — Docker image registry server, without protocol such as `http` and `https`.
          - `username` string, required — The username for the private registry.
          - `passwordType` 'ClearText' | 'KeyVaultReference' | 'SecretValueReference' — The type of the image registry password being given in password
          - `password` string — The password for the private registry. The password is required for create or update operations, however it is not returned in the get or list operations. Will be processed based on the type provided.
        - `entryPoint` string — Override for the default entry point in the container.
        - `commands` string[] — Command array to execute within the container in exec form.
        - `environmentVariables` EnvironmentVariable[] — The environment variables to set in this container
          - `type` 'ClearText' | 'KeyVaultReference' | 'SecretValueReference' — The type of the environment variable being given in value
          - `name` string — The name of the environment variable.
          - `value` string — The value of the environment variable, will be processed based on the type provided.
        - `settings` Setting[] — The settings to set in this container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\\secrets". The path for Linux container is "/var/secrets".
          - `type` 'ClearText' | 'KeyVaultReference' | 'SecretValueReference' — The type of the setting being given in value
          - `name` string — The name of the setting.
          - `value` string — The value of the setting, will be processed based on the type provided.
        - `labels` ContainerLabel[] — The labels to set in this container.
          - `name` string, required — The name of the container label.
          - `value` string, required — The value of the container label.
        - `endpoints` EndpointProperties[] — The endpoints exposed by this container.
          - `name` string, required — The name of the endpoint.
          - `port` integer — Port used by the container.
        - `resources` ResourceRequirements, required — This type describes the resource requirements for a container or a service.
          - `requests` ResourceRequests, required — This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits.
            - `memoryInGB` number, double, required — The memory request in GB for this container.
            - `cpu` number, double, required — Requested number of CPU cores. At present, only full cores are supported.
          - `limits` ResourceLimits — This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted.
            - `memoryInGB` number, double — The memory limit in GB.
            - `cpu` number, double — CPU limits in cores. At present, only full cores are supported.
        - `volumeRefs` VolumeReference[] — Volumes to be attached to the container. The lifetime of these volumes is independent of the application's lifetime.
          - `name` string, required — Name of the volume being referenced.
          - `readOnly` boolean — The flag indicating whether the volume is read only. Default is 'false'.
          - `destinationPath` string, required — The path within the container at which the volume should be mounted. Only valid path characters are allowed.
        - `volumes` ApplicationScopedVolume[] — Volumes to be attached to the container. The lifetime of these volumes is scoped to the application's lifetime.
          - `name` string, required — Name of the volume being referenced.
          - `readOnly` boolean — The flag indicating whether the volume is read only. Default is 'false'.
          - `destinationPath` string, required — The path within the container at which the volume should be mounted. Only valid path characters are allowed.
        - `diagnostics` DiagnosticsRef — Reference to sinks in DiagnosticsDescription.
          - `enabled` boolean — Status of whether or not sinks are enabled.
          - `sinkRefs` string[] — List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription.
        - `reliableCollectionsRefs` ReliableCollectionsRef[] — A list of ReliableCollection resources used by this particular code package. Please refer to ReliableCollectionsRef for more details.
          - `name` string, required — Name of ReliableCollection resource. Right now it's not used and you can use any string.
          - `doNotPersistState` boolean — False (the default) if ReliableCollections state is persisted to disk as usual. True if you do not want to persist state, in which case replication is still enabled and you can use ReliableCollections as distributed cache.
        - `instanceView` ContainerInstanceView — Runtime information of a container instance.
          - `restartCount` integer — The number of times the container has been restarted.
          - `currentState` ContainerState — The container state.
            - `state` string — The state of this container
            - `startTime` string, date-time — Date/time when the container state started.
            - `exitCode` string — The container exit code.
            - `finishTime` string, date-time — Date/time when the container state finished.
            - `detailStatus` string — Human-readable status of this state.
          - `previousState` ContainerState — The container state.
            - `state` string — The state of this container
            - `startTime` string, date-time — Date/time when the container state started.
            - `exitCode` string — The container exit code.
            - `finishTime` string, date-time — Date/time when the container state finished.
            - `detailStatus` string — Human-readable status of this state.
          - `events` ContainerEvent[] — The events of this container instance.
            - `name` string — The name of the container event.
            - `count` integer — The count of the event.
            - `firstTimestamp` string — Date/time of the first event.
            - `lastTimestamp` string — Date/time of the last event.
            - `message` string — The event message
            - `type` string — The event type.
        - `livenessProbe` Probe[] — An array of liveness probes for a code package. It determines when to restart a code package.
          - `initialDelaySeconds` integer — The initial delay in seconds to start executing probe once codepackage has started.
          - `periodSeconds` integer — Periodic seconds to execute probe.
          - `timeoutSeconds` integer — Period after which probe is considered as failed if it hasn't completed successfully.
          - `successThreshold` integer — The count of successful probe executions after which probe is considered success.
          - `failureThreshold` integer — The count of failures after which probe is considered failed.
          - `exec` ProbeExec — Exec command to run inside the container.
            - `command` string, required — Comma separated command to run inside the container for example "sh, -c, echo hello world".
          - `httpGet` ProbeHttpGet — Http probe for the container.
            - `port` integer, required — Port to access for probe.
            - `path` string — Path to access on the HTTP request.
            - `host` string — Host IP to connect to.
            - `httpHeaders` ProbeHttpGetHeaders[] — Headers to set in the request.
              - …
            - `scheme` 'http' | 'https' — Scheme for the http probe. Can be Http or Https.
          - `tcpSocket` ProbeTcpSocket — Tcp port to probe inside the container.
            - `port` integer, required — Port to access for probe.
        - `readinessProbe` Probe[] — An array of readiness probes for a code package. It determines when to unpublish an endpoint.
          - `initialDelaySeconds` integer — The initial delay in seconds to start executing probe once codepackage has started.
          - `periodSeconds` integer — Periodic seconds to execute probe.
          - `timeoutSeconds` integer — Period after which probe is considered as failed if it hasn't completed successfully.
          - `successThreshold` integer — The count of successful probe executions after which probe is considered success.
          - `failureThreshold` integer — The count of failures after which probe is considered failed.
          - `exec` ProbeExec — Exec command to run inside the container.
            - `command` string, required — Comma separated command to run inside the container for example "sh, -c, echo hello world".
          - `httpGet` ProbeHttpGet — Http probe for the container.
            - `port` integer, required — Port to access for probe.
            - `path` string — Path to access on the HTTP request.
            - `host` string — Host IP to connect to.
            - `httpHeaders` ProbeHttpGetHeaders[] — Headers to set in the request.
              - …
            - `scheme` 'http' | 'https' — Scheme for the http probe. Can be Http or Https.
          - `tcpSocket` ProbeTcpSocket — Tcp port to probe inside the container.
            - `port` integer, required — Port to access for probe.
      - `networkRefs` NetworkRef[] — The names of the private networks that this service needs to be part of.
        - `name` string — Name of the network
        - `endpointRefs` EndpointRef[] — A list of endpoints that are exposed on this network.
          - `name` string — Name of the endpoint.
      - `diagnostics` DiagnosticsRef — Reference to sinks in DiagnosticsDescription.
        - `enabled` boolean — Status of whether or not sinks are enabled.
        - `sinkRefs` string[] — List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription.
      - `description` string — User readable description of the service.
      - `replicaCount` integer — The number of replicas of the service to create. Defaults to 1 if not specified.
      - `executionPolicy` ExecutionPolicy — The execution policy of the service
        - `type` 'Default' | 'RunToCompletion', required — Enumerates the execution policy types for services.
      - `autoScalingPolicies` AutoScalingPolicy[] — Auto scaling policies
        - `name` string, required — The name of the auto scaling policy.
        - `trigger` AutoScalingTrigger, required — Describes the trigger for performing auto scaling operation.
          - `kind` 'AverageLoad', required — Enumerates the triggers for auto scaling.
        - `mechanism` AutoScalingMechanism, required — Describes the mechanism for performing auto scaling operation. Derived classes will describe the actual mechanism.
          - `kind` 'AddRemoveReplica', required — Enumerates the mechanisms for auto scaling.
      - `status` 'Unknown' | 'Ready' | 'Upgrading' | 'Creating' | 'Deleting' | 'Failed' — Status of the resource.
      - `statusDetails` string — Gives additional information about the current status of the service.
      - `healthState` 'Invalid' | 'Ok' | 'Warning' | 'Error' | 'Unknown' — The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
      - `unhealthyEvaluation` string — When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy.
      - `identityRefs` ServiceIdentity[] — The service identity list.
        - `name` string — The identity friendly name.
        - `identityRef` string — The application identity name.
      - `dnsName` string — Dns name of the service.

## Other responses

- `default` — Error

---

[API](https://skmtc.net/azure/apis/servicefabric-servicefabric.md) · [All operations](https://skmtc.net/azure/apis/servicefabric-servicefabric/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/servicefabric-servicefabric/versions/6ebed3032b57/schema)