Deployments - List For Cluster

Service:: Azure Spring Apps

API Version:: 2023-12-01

List deployments for a certain service

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/deployments?api-version=2023-12-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/deployments?api-version=2023-12-01&version={version}&$expand={$expand}

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	The name of the Service resource.
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 minLength: 1	The API version to use for this operation.
$expand	query		string	The expand expression to apply on the operation.
version	query		string[]	Version of the deployments to be listed

Responses

Name	Type	Description
200 OK	DeploymentResourceCollection	Success
Other Status Codes	CloudError	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

Deployments_ListForCluster

Sample request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/deployments?api-version=2023-12-01


/**
 * Samples for Deployments ListForCluster.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/
     * Deployments_ListForCluster.json
     */
    /**
     * Sample code: Deployments_ListForCluster.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void deploymentsListForCluster(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getDeployments().listForCluster("myResourceGroup", "myservice",
            null, null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.appplatform import AppPlatformManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appplatform
# USAGE
    python deployments_list_for_cluster.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 = AppPlatformManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.deployments.list_for_cluster(
        resource_group_name="myResourceGroup",
        service_name="myservice",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_ListForCluster.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

package armappplatform_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_ListForCluster.json
func ExampleDeploymentsClient_NewListForClusterPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewDeploymentsClient().NewListForClusterPager("myResourceGroup", "myservice", &armappplatform.DeploymentsClientListForClusterOptions{Version: []string{},
		Expand: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DeploymentResourceCollection = armappplatform.DeploymentResourceCollection{
		// 	Value: []*armappplatform.DeploymentResource{
		// 		{
		// 			Name: to.Ptr("mydeployment"),
		// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/apps/deployments"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment"),
		// 			SystemData: &armappplatform.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
		// 				CreatedBy: to.Ptr("sample-user"),
		// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("sample-user"),
		// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
		// 			},
		// 			Properties: &armappplatform.DeploymentResourceProperties{
		// 				Active: to.Ptr(true),
		// 				DeploymentSettings: &armappplatform.DeploymentSettings{
		// 					Apms: []*armappplatform.ApmReference{
		// 						{
		// 							ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
		// 					}},
		// 					EnvironmentVariables: map[string]*string{
		// 						"env": to.Ptr("test"),
		// 					},
		// 					ResourceRequests: &armappplatform.ResourceRequests{
		// 						CPU: to.Ptr("1000m"),
		// 						Memory: to.Ptr("3Gi"),
		// 					},
		// 				},
		// 				Instances: []*armappplatform.DeploymentInstance{
		// 					{
		// 						Name: to.Ptr("instance1"),
		// 						DiscoveryStatus: to.Ptr("pending"),
		// 						StartTime: to.Ptr("2020-08-26T01:55:02Z"),
		// 						Status: to.Ptr("Running"),
		// 				}},
		// 				ProvisioningState: to.Ptr(armappplatform.DeploymentResourceProvisioningStateSucceeded),
		// 				Source: &armappplatform.SourceUploadedUserSourceInfo{
		// 					Type: to.Ptr("Source"),
		// 					Version: to.Ptr("1.0"),
		// 					RelativePath: to.Ptr("resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc"),
		// 					ArtifactSelector: to.Ptr("sub-module-1"),
		// 				},
		// 				Status: to.Ptr(armappplatform.DeploymentResourceStatusRunning),
		// 			},
		// 			SKU: &armappplatform.SKU{
		// 				Name: to.Ptr("S0"),
		// 				Capacity: to.Ptr[int32](1),
		// 				Tier: to.Ptr("Standard"),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { AppPlatformManagementClient } = require("@azure/arm-appplatform");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List deployments for a certain service
 *
 * @summary List deployments for a certain service
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_ListForCluster.json
 */
async function deploymentsListForCluster() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
  const serviceName = "myservice";
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.deployments.listForCluster(resourceGroupName, serviceName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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": [
    {
      "properties": {
        "source": {
          "type": "Source",
          "relativePath": "resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc",
          "version": "1.0",
          "artifactSelector": "sub-module-1"
        },
        "deploymentSettings": {
          "resourceRequests": {
            "cpu": "1000m",
            "memory": "3Gi"
          },
          "environmentVariables": {
            "env": "test"
          },
          "apms": [
            {
              "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"
            }
          ]
        },
        "provisioningState": "Succeeded",
        "status": "Running",
        "active": true,
        "instances": [
          {
            "name": "instance1",
            "status": "Running",
            "discoveryStatus": "pending",
            "startTime": "2020-08-26T01:55:02Z"
          }
        ]
      },
      "sku": {
        "name": "S0",
        "tier": "Standard",
        "capacity": 1
      },
      "systemData": {
        "createdBy": "sample-user",
        "createdByType": "User",
        "createdAt": "2021-08-11T03:16:03.944Z",
        "lastModifiedBy": "sample-user",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-08-11T03:17:03.944Z"
      },
      "type": "Microsoft.AppPlatform/Spring/apps/deployments",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment",
      "name": "mydeployment"
    }
  ]
}

Definitions

Name	Description
ApmReference	A reference to the APM
BuildResultUserSourceInfo	Reference to a build result
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
ContainerProbeSettings	Container liveness and readiness probe settings
createdByType	The type of identity that created the resource.
CustomContainer	Custom container payload
CustomContainerUserSourceInfo	Custom container user source info
DeploymentInstance	Deployment instance payload
DeploymentResource	Deployment resource payload
DeploymentResourceCollection	Object that includes an array of App resources and a possible link for next set
DeploymentResourceProperties	Deployment resource properties payload
DeploymentResourceProvisioningState	Provisioning state of the Deployment
DeploymentResourceStatus	Status of the Deployment
DeploymentSettings	Deployment settings payload
ExecAction	ExecAction describes a "run in container" action.
HTTPGetAction	HTTPGetAction describes an action based on HTTP Get requests.
HTTPSchemeType	Scheme to use for connecting to the host. Defaults to HTTP. Possible enum values: `"HTTP"` means that the scheme used will be http:// `"HTTPS"` means that the scheme used will be https://
ImageRegistryCredential	Credential of the image registry
lastModifiedByType	The type of identity that last modified the resource.
Probe	Probe describes a health check to be performed against an App Instance to determine whether it is alive or ready to receive traffic.
ResourceRequests	Deployment resource request payload
Sku	Sku of Azure Spring Apps
SystemData	Metadata pertaining to creation and last modification of the resource.
TCPSocketAction	TCPSocketAction describes an action based on opening a socket

ApmReference

Object

A reference to the APM

Name	Type	Description
resourceId	string (arm-id)	Resource Id of the APM

BuildResultUserSourceInfo

Object

Reference to a build result

Name	Type	Description
buildResultId	string	Resource id of an existing succeeded build result under the same Spring instance.
type	string: BuildResult	Type of the source uploaded
version	string	Version of the source

CloudError

Object

An error response from the service.

Name	Type	Description
error	CloudErrorBody	An error response from the service.

CloudErrorBody

Object

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	CloudErrorBody[]	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.

ContainerProbeSettings

Object

Container liveness and readiness probe settings

Name	Type	Description
disableProbe	boolean	Indicates whether disable the liveness and readiness probe

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

CustomContainer

Object

Custom container payload

Name	Type	Description
args	string[]	Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
command	string[]	Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
containerImage	string	Container image of the custom container. This should be in the form of <repository>:<tag> without the server name of the registry
imageRegistryCredential	ImageRegistryCredential	Credential of the image registry
languageFramework	string	Language framework of the container image uploaded. Supported values: "springboot", "", null.
server	string	The name of the registry that contains the container image

CustomContainerUserSourceInfo

Object

Custom container user source info

Name	Type	Description
customContainer	CustomContainer	Custom container payload
type	string: Container	Type of the source uploaded
version	string	Version of the source

DeploymentInstance

Object

Deployment instance payload

Name	Type	Description
discoveryStatus	string	Discovery status of the deployment instance
name	string	Name of the deployment instance
reason	string	Failed reason of the deployment instance
startTime	string	Start time of the deployment instance
status	string	Status of the deployment instance
zone	string	Availability zone information of the deployment instance

DeploymentResource

Object

Deployment resource payload

Name	Type	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
properties	DeploymentResourceProperties	Properties of the Deployment resource
sku	Sku	Sku of the Deployment resource
systemData	SystemData	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

DeploymentResourceCollection

Object

Object that includes an array of App 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	DeploymentResource[]	Collection of Deployment resources

DeploymentResourceProperties

Object

Deployment resource properties payload

Name	Type	Description
active	boolean	Indicates whether the Deployment is active
deploymentSettings	DeploymentSettings	Deployment settings of the Deployment
instances	DeploymentInstance[]	Collection of instances belong to the Deployment
provisioningState	DeploymentResourceProvisioningState	Provisioning state of the Deployment
source	UserSourceInfo: BuildResultUserSourceInfo CustomContainerUserSourceInfo	Uploaded source information of the deployment.
status	DeploymentResourceStatus	Status of the Deployment

DeploymentResourceProvisioningState

Enumeration

Provisioning state of the Deployment

Value	Description
Creating
Updating
Succeeded
Failed

DeploymentResourceStatus

Enumeration

Status of the Deployment

Value	Description
Stopped
Running

DeploymentSettings

Object

Deployment settings payload

Name	Type	Default value	Description
addonConfigs	object		Collection of addons
apms	ApmReference[]		Collection of ApmReferences
containerProbeSettings	ContainerProbeSettings		Container liveness and readiness probe settings
environmentVariables	object		Collection of environment variables
livenessProbe	Probe		Periodic probe of App Instance liveness. App Instance will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
readinessProbe	Probe		Periodic probe of App Instance service readiness. App Instance will be removed from service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
resourceRequests	ResourceRequests		The requested resource quantity for required CPU and Memory. It is recommended that using this field to represent the required CPU and Memory, the old field cpu and memoryInGB will be deprecated later.
startupProbe	Probe		StartupProbe indicates that the App Instance has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a App Instance's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
terminationGracePeriodSeconds	integer (int32)	90	Optional duration in seconds the App Instance needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the App Instance are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 90 seconds.

ExecAction

Object

ExecAction describes a "run in container" action.

Name	Type	Description
command	string[]	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
type	string: ExecAction	The type of the action to take to perform the health check.

HTTPGetAction

Object

HTTPGetAction describes an action based on HTTP Get requests.

Name Type Description

path

Name	Type	Description
path	string	Path to access on the HTTP server.
scheme	HTTPSchemeType	Scheme to use for connecting to the host. Defaults to HTTP. Possible enum values: `"HTTP"` means that the scheme used will be http:// `"HTTPS"` means that the scheme used will be https://
type	string: HTTPGetAction	The type of the action to take to perform the health check.

string

Path to access on the HTTP server.

scheme

HTTPSchemeType

Scheme to use for connecting to the host. Defaults to HTTP.

Possible enum values:

"HTTP" means that the scheme used will be http://
"HTTPS" means that the scheme used will be https://

type

string:

HTTPGetAction

The type of the action to take to perform the health check.

HTTPSchemeType

Enumeration

Scheme to use for connecting to the host. Defaults to HTTP.

Possible enum values:

"HTTP" means that the scheme used will be http://
"HTTPS" means that the scheme used will be https://

Value	Description
HTTP
HTTPS

ImageRegistryCredential

Object

Credential of the image registry

Name	Type	Description
password	string	The password of the image registry credential
username	string	The username of the image registry credential

lastModifiedByType

Enumeration

The type of identity that last modified the resource.

Value	Description
User
Application
ManagedIdentity
Key

Probe

Object

Probe describes a health check to be performed against an App Instance to determine whether it is alive or ready to receive traffic.

Name	Type	Default value	Description
disableProbe	boolean	False	Indicate whether the probe is disabled.
failureThreshold	integer (int32)		Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.
initialDelaySeconds	integer (int32)		Number of seconds after the App Instance has started before probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
periodSeconds	integer (int32)		How often (in seconds) to perform the probe. Minimum value is 1.
probeAction	ProbeAction: ExecAction HTTPGetAction TCPSocketAction		The action of the probe.
successThreshold	integer (int32)		Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 for liveness and startup. Minimum value is 1.
timeoutSeconds	integer (int32)		Number of seconds after which the probe times out. Minimum value is 1.

ResourceRequests

Object

Deployment resource request payload

Name	Type	Description
cpu	string	Required CPU. 1 core can be represented by 1 or 1000m. This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4} for Standard tier.
memory	string	Required memory. 1 GB can be represented by 1Gi or 1024Mi. This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier.

Sku

Object

Sku of Azure Spring Apps

Name	Type	Default value	Description
capacity	integer (int32)		Current capacity of the target resource
name	string	S0	Name of the Sku
tier	string	Standard	Tier of the Sku

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	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource modification (UTC).
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	lastModifiedByType	The type of identity that last modified the resource.

TCPSocketAction

Object

TCPSocketAction describes an action based on opening a socket

Name	Type	Description
type	string: TCPSocketAction	The type of the action to take to perform the health check.

Share via

Deployments - List For Cluster

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Deployments_ListForCluster

Sample request

Sample response

Definitions

ApmReference

BuildResultUserSourceInfo

CloudError

CloudErrorBody

ContainerProbeSettings

createdByType

CustomContainer

CustomContainerUserSourceInfo

DeploymentInstance

DeploymentResource

DeploymentResourceCollection

DeploymentResourceProperties

DeploymentResourceProvisioningState

DeploymentResourceStatus

DeploymentSettings

ExecAction

HTTPGetAction

HTTPSchemeType

ImageRegistryCredential

lastModifiedByType

Probe

ResourceRequests

Sku

SystemData

TCPSocketAction