Services - List By Subscription

Handles requests to list all resources in a subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.AppPlatform/Spring?api-version=2019-05-01-preview

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True
  • string

Client Api Version.

Responses

Name Type Description
200 OK

Success. The response describes the list of Services in the subscription.

Other Status Codes

Error response describing why the operation failed.

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

Services_ListBySubscription

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.AppPlatform/Spring?api-version=2019-05-01-preview

Sample Response

{
  "value": [
    {
      "properties": {
        "provisioningState": "Succeeded",
        "configServerProperties": {
          "state": "Succeeded",
          "configServer": {
            "gitProperty": {
              "uri": "https://github.com/fake-user/fake-repository.git",
              "label": "master",
              "searchPaths": [
                "/"
              ]
            }
          }
        },
        "trace": {
          "state": "Succeeded",
          "enabled": true,
          "appInsightInstrumentationKey": "00000000-0000-0000-0000-000000000000"
        },
        "serviceId": "12345678abcd1234abcd12345678abcd",
        "networkProfile": {
          "outboundIPs": {
            "publicIPs": [
              "20.39.3.173",
              "40.64.67.13"
            ]
          },
          "requiredTraffics": [
            {
              "protocol": "TCP",
              "port": 443,
              "ips": [
                "20.62.211.25",
                "52.188.47.226"
              ],
              "direction": "Outbound"
            },
            {
              "protocol": "UDP",
              "port": 1194,
              "ips": [
                "20.62.211.25",
                "52.188.47.226"
              ],
              "direction": "Outbound"
            },
            {
              "protocol": "TCP",
              "port": 9000,
              "ips": [
                "20.62.211.25",
                "52.188.47.226"
              ],
              "direction": "Outbound"
            }
          ]
        }
      },
      "type": "Microsoft.AppPlatform/Spring",
      "sku": {
        "name": "S0",
        "tier": "Standard"
      },
      "location": "eastus",
      "tags": {
        "key1": "value1"
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice",
      "name": "myservice"
    }
  ]
}

Definitions

CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

ClusterResourceProperties

Service properties payload

ConfigServerGitProperty

Property of git.

ConfigServerProperties

Config server git properties payload

ConfigServerSettings

The settings of config server.

ConfigServerState

State of the config server.

Error

The error code compose of code and message.

GitPatternRepository

Git repository property payload

NetworkProfile

Service network profile payload

OutboundIPs

Desired outbound IP resources for Azure Spring Cloud instance.

ProvisioningState

Provisioning state of the Service

RequiredTraffic

Required inbound or outbound traffic for Azure Spring Cloud instance.

ServiceResource

Service resource

ServiceResourceList

Object that includes an array of Service resources and a possible link for next set

Sku

Sku of Azure Spring Cloud

TraceProperties

Trace properties payload

TraceProxyState

State of the trace proxy.

trafficDirection

The direction of required traffic

CloudError

An error response from the service.

Name Type Description
error

An error response from the service.

CloudErrorBody

An error response from the service.

Name Type Description
code
  • string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

A list of additional details about the error.

message
  • string

A message describing the error, intended to be suitable for display in a user interface.

target
  • string

The target of the particular error. For example, the name of the property in error.

ClusterResourceProperties

Service properties payload

Name Type Description
configServerProperties

Config server git properties of the Service

networkProfile

Network profile of the Service

provisioningState

Provisioning state of the Service

serviceId
  • string

ServiceInstanceEntity GUID which uniquely identifies a created resource

trace

Trace properties of the Service

version
  • integer

Version of the Service

ConfigServerGitProperty

Property of git.

Name Type Description
hostKey
  • string

Public sshKey of git repository.

hostKeyAlgorithm
  • string

SshKey algorithm of git repository.

label
  • string

Label of the repository

password
  • string

Password of git repository basic auth.

privateKey
  • string

Private sshKey algorithm of git repository.

repositories

Repositories of git.

searchPaths
  • string[]

Searching path of the repository

strictHostKeyChecking
  • boolean

Strict host key checking or not.

uri
  • string

URI of the repository

username
  • string

Username of git repository basic auth.

ConfigServerProperties

Config server git properties payload

Name Type Description
configServer

Settings of config server.

error

Error when apply config server settings.

state

State of the config server.

ConfigServerSettings

The settings of config server.

Name Type Description
gitProperty

Property of git environment.

ConfigServerState

State of the config server.

Name Type Description
Deleted
  • string
Failed
  • string
NotAvailable
  • string
Succeeded
  • string
Updating
  • string

Error

The error code compose of code and message.

Name Type Description
code
  • string

The code of error.

message
  • string

The message of error.

GitPatternRepository

Git repository property payload

Name Type Description
hostKey
  • string

Public sshKey of git repository.

hostKeyAlgorithm
  • string

SshKey algorithm of git repository.

label
  • string

Label of the repository

name
  • string

Name of the repository

password
  • string

Password of git repository basic auth.

pattern
  • string[]

Collection of pattern of the repository

privateKey
  • string

Private sshKey algorithm of git repository.

searchPaths
  • string[]

Searching path of the repository

strictHostKeyChecking
  • boolean

Strict host key checking or not.

uri
  • string

URI of the repository

username
  • string

Username of git repository basic auth.

NetworkProfile

Service network profile payload

Name Type Description
appNetworkResourceGroup
  • string

Name of the resource group containing network resources of Azure Spring Cloud Apps

appSubnetId
  • string

Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps

outboundIPs

Desired outbound IP resources for Azure Spring Cloud instance.

requiredTraffics

Required inbound or outbound traffics for Azure Spring Cloud instance.

serviceCidr
  • string

Azure Spring Cloud service reserved CIDR

serviceRuntimeNetworkResourceGroup
  • string

Name of the resource group containing network resources of Azure Spring Cloud Service Runtime

serviceRuntimeSubnetId
  • string

Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime

OutboundIPs

Desired outbound IP resources for Azure Spring Cloud instance.

Name Type Description
publicIPs
  • string[]

A list of public IP addresses.

ProvisioningState

Provisioning state of the Service

Name Type Description
Creating
  • string
Deleted
  • string
Deleting
  • string
Failed
  • string
MoveFailed
  • string
Moved
  • string
Moving
  • string
Succeeded
  • string
Updating
  • string

RequiredTraffic

Required inbound or outbound traffic for Azure Spring Cloud instance.

Name Type Description
direction

The direction of required traffic

fqdns
  • string[]

The FQDN list of required traffic

ips
  • string[]

The ip list of required traffic

port
  • integer

The port of required traffic

protocol
  • string

The protocol of required traffic

ServiceResource

Service resource

Name Type Description
id
  • string

Fully qualified resource Id for the resource.

location
  • string

The GEO location of the resource.

name
  • string

The name of the resource.

properties

Properties of the Service resource

sku

Sku of the Service resource

tags
  • object

Tags of the service which is a list of key value pairs that describe the resource.

type
  • string

The type of the resource.

ServiceResourceList

Object that includes an array of Service resources and a possible link for next set

Name Type Description
nextLink
  • string

URL client should use to fetch the next page (per server side paging). It's null for now, added for future use.

value

Collection of Service resources

Sku

Sku of Azure Spring Cloud

Name Type Description
capacity
  • integer

Current capacity of the target resource

name
  • string

Name of the Sku

tier
  • string

Tier of the Sku

TraceProperties

Trace properties payload

Name Type Description
appInsightInstrumentationKey
  • string

Target application insight instrumentation key

enabled
  • boolean

Indicates whether enable the tracing functionality

error

Error when apply trace proxy changes.

state

State of the trace proxy.

TraceProxyState

State of the trace proxy.

Name Type Description
Failed
  • string
NotAvailable
  • string
Succeeded
  • string
Updating
  • string

trafficDirection

The direction of required traffic

Name Type Description
Inbound
  • string
Outbound
  • string