Deployments - Create Or Update

Service:

Azure Spring Apps

API Version:

2023-12-01

Erstellen Sie eine neue Bereitstellung, oder aktualisieren Sie eine beendende Bereitstellung.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
appName	path	True	string	Der Name der App-Ressource.
deploymentName	path	True	string	Der Name der Bereitstellungsressource.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
serviceName	path	True	string	Der Name der Dienstressource. Regex pattern: ^[a-z][a-z0-9-]*[a-z0-9]$
subscriptionId	path	True	string	Ruft die Abonnement-ID ab, die das Microsoft Azure-Abonnement eindeutig identifiziert. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Typ	Beschreibung
properties	DeploymentResourceProperties	Eigenschaften der Bereitstellungsressource
sku	Sku	Sku der Bereitstellungsressource

Antworten

Name	Typ	Beschreibung
200 OK	DeploymentResource	Erfolg. Die Antwort beschreibt die aktualisierte Bereitstellung.
201 Created	DeploymentResource	Erstellt. Die Antwort beschreibt die neue Bereitstellung und enthält einen Azure-AsyncOperation-Header zum Abfragen des Vorgangsergebnisses.
202 Accepted	DeploymentResource	Akzeptiert: Die Antwort gibt an, dass die beendende Bereitstellung jetzt aktualisiert wird und einen Location-Header enthält, um das Vorgangsergebnis abzufragen.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Deployments_CreateOrUpdate

Deployments_CreateOrUpdate_CustomContainer

Deployments_CreateOrUpdate

Sample Request

HTTP

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

{
  "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"
      },
      "addonConfigs": {
        "ApplicationConfigurationService": {
          "patterns": [
            "mypattern"
          ]
        }
      },
      "environmentVariables": {
        "env": "test"
      },
      "apms": [
        {
          "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"
        }
      ],
      "terminationGracePeriodSeconds": 30,
      "livenessProbe": {
        "disableProbe": false,
        "initialDelaySeconds": 30,
        "periodSeconds": 10,
        "failureThreshold": 3,
        "probeAction": {
          "type": "HTTPGetAction",
          "path": "/health",
          "scheme": "HTTP"
        }
      },
      "readinessProbe": {
        "disableProbe": false,
        "initialDelaySeconds": 30,
        "periodSeconds": 10,
        "failureThreshold": 3,
        "probeAction": {
          "type": "HTTPGetAction",
          "path": "/health",
          "scheme": "HTTP"
        }
      },
      "startupProbe": null
    },
    "instances": null
  },
  "sku": {
    "name": "S0",
    "tier": "Standard",
    "capacity": 1
  }
}

Java

import com.azure.core.management.serializer.SerializerFactory;
import com.azure.core.util.serializer.SerializerEncoding;
import com.azure.resourcemanager.appplatform.fluent.models.DeploymentResourceInner;
import com.azure.resourcemanager.appplatform.models.ApmReference;
import com.azure.resourcemanager.appplatform.models.DeploymentResourceProperties;
import com.azure.resourcemanager.appplatform.models.DeploymentSettings;
import com.azure.resourcemanager.appplatform.models.HttpGetAction;
import com.azure.resourcemanager.appplatform.models.HttpSchemeType;
import com.azure.resourcemanager.appplatform.models.Probe;
import com.azure.resourcemanager.appplatform.models.ResourceRequests;
import com.azure.resourcemanager.appplatform.models.Sku;
import com.azure.resourcemanager.appplatform.models.SourceUploadedUserSourceInfo;
import java.io.IOException;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Deployments CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/
     * Deployments_CreateOrUpdate.json
     */
    /**
     * Sample code: Deployments_CreateOrUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void deploymentsCreateOrUpdate(com.azure.resourcemanager.AzureResourceManager azure)
        throws IOException {
        azure.springServices().manager().serviceClient().getDeployments().createOrUpdate("myResourceGroup", "myservice",
            "myapp", "mydeployment",
            new DeploymentResourceInner().withProperties(new DeploymentResourceProperties()
                .withSource(new SourceUploadedUserSourceInfo().withVersion("1.0").withRelativePath(
                    "resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc")
                    .withArtifactSelector("sub-module-1"))
                .withDeploymentSettings(new DeploymentSettings()
                    .withResourceRequests(new ResourceRequests().withCpu("1000m").withMemory("3Gi"))
                    .withEnvironmentVariables(mapOf("env", "test"))
                    .withApms(Arrays.asList(new ApmReference().withResourceId(
                        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights")))
                    .withAddonConfigs(mapOf("ApplicationConfigurationService",
                        mapOf("patterns",
                            SerializerFactory.createDefaultManagementSerializerAdapter().deserialize("[\"mypattern\"]",
                                Object.class, SerializerEncoding.JSON))))
                    .withLivenessProbe(new Probe()
                        .withProbeAction(new HttpGetAction().withPath("/health").withScheme(HttpSchemeType.HTTP))
                        .withDisableProbe(false).withInitialDelaySeconds(30).withPeriodSeconds(10)
                        .withFailureThreshold(3))
                    .withReadinessProbe(new Probe()
                        .withProbeAction(new HttpGetAction().withPath("/health").withScheme(HttpSchemeType.HTTP))
                        .withDisableProbe(false).withInitialDelaySeconds(30).withPeriodSeconds(10)
                        .withFailureThreshold(3))
                    .withTerminationGracePeriodSeconds(30)))
                .withSku(new Sku().withName("S0").withTier("Standard").withCapacity(1)),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.appplatform import AppPlatformManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appplatform
# USAGE
    python deployments_create_or_update.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.begin_create_or_update(
        resource_group_name="myResourceGroup",
        service_name="myservice",
        app_name="myapp",
        deployment_name="mydeployment",
        deployment_resource={
            "properties": {
                "deploymentSettings": {
                    "addonConfigs": {"ApplicationConfigurationService": {"patterns": ["mypattern"]}},
                    "apms": [
                        {
                            "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"
                        }
                    ],
                    "environmentVariables": {"env": "test"},
                    "livenessProbe": {
                        "disableProbe": False,
                        "failureThreshold": 3,
                        "initialDelaySeconds": 30,
                        "periodSeconds": 10,
                        "probeAction": {"path": "/health", "scheme": "HTTP", "type": "HTTPGetAction"},
                    },
                    "readinessProbe": {
                        "disableProbe": False,
                        "failureThreshold": 3,
                        "initialDelaySeconds": 30,
                        "periodSeconds": 10,
                        "probeAction": {"path": "/health", "scheme": "HTTP", "type": "HTTPGetAction"},
                    },
                    "resourceRequests": {"cpu": "1000m", "memory": "3Gi"},
                    "startupProbe": None,
                    "terminationGracePeriodSeconds": 30,
                },
                "instances": None,
                "source": {
                    "artifactSelector": "sub-module-1",
                    "relativePath": "resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc",
                    "type": "Source",
                    "version": "1.0",
                },
            },
            "sku": {"capacity": 1, "name": "S0", "tier": "Standard"},
        },
    ).result()
    print(response)


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

Go

package armappplatform_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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_CreateOrUpdate.json
func ExampleDeploymentsClient_BeginCreateOrUpdate_deploymentsCreateOrUpdate() {
	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)
	}
	poller, err := clientFactory.NewDeploymentsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "myapp", "mydeployment", armappplatform.DeploymentResource{
		Properties: &armappplatform.DeploymentResourceProperties{
			DeploymentSettings: &armappplatform.DeploymentSettings{
				AddonConfigs: map[string]any{
					"ApplicationConfigurationService": map[string]any{
						"patterns": []any{
							"mypattern",
						},
					},
				},
				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"),
				},
				LivenessProbe: &armappplatform.Probe{
					DisableProbe:        to.Ptr(false),
					FailureThreshold:    to.Ptr[int32](3),
					InitialDelaySeconds: to.Ptr[int32](30),
					PeriodSeconds:       to.Ptr[int32](10),
					ProbeAction: &armappplatform.HTTPGetAction{
						Type:   to.Ptr(armappplatform.ProbeActionTypeHTTPGetAction),
						Path:   to.Ptr("/health"),
						Scheme: to.Ptr(armappplatform.HTTPSchemeTypeHTTP),
					},
				},
				ReadinessProbe: &armappplatform.Probe{
					DisableProbe:        to.Ptr(false),
					FailureThreshold:    to.Ptr[int32](3),
					InitialDelaySeconds: to.Ptr[int32](30),
					PeriodSeconds:       to.Ptr[int32](10),
					ProbeAction: &armappplatform.HTTPGetAction{
						Type:   to.Ptr(armappplatform.ProbeActionTypeHTTPGetAction),
						Path:   to.Ptr("/health"),
						Scheme: to.Ptr(armappplatform.HTTPSchemeTypeHTTP),
					},
				},
				ResourceRequests: &armappplatform.ResourceRequests{
					CPU:    to.Ptr("1000m"),
					Memory: to.Ptr("3Gi"),
				},
				TerminationGracePeriodSeconds: to.Ptr[int32](30),
			},
			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"),
			},
		},
		SKU: &armappplatform.SKU{
			Name:     to.Ptr("S0"),
			Capacity: to.Ptr[int32](1),
			Tier:     to.Ptr("Standard"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DeploymentResource = 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(false),
	// 		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"),
	// 			},
	// 			LivenessProbe: &armappplatform.Probe{
	// 				DisableProbe: to.Ptr(false),
	// 				FailureThreshold: to.Ptr[int32](3),
	// 				InitialDelaySeconds: to.Ptr[int32](30),
	// 				PeriodSeconds: to.Ptr[int32](10),
	// 				ProbeAction: &armappplatform.HTTPGetAction{
	// 					Type: to.Ptr(armappplatform.ProbeActionTypeHTTPGetAction),
	// 					Path: to.Ptr("/health"),
	// 					Scheme: to.Ptr(armappplatform.HTTPSchemeTypeHTTP),
	// 				},
	// 			},
	// 			ReadinessProbe: &armappplatform.Probe{
	// 				DisableProbe: to.Ptr(false),
	// 				FailureThreshold: to.Ptr[int32](3),
	// 				InitialDelaySeconds: to.Ptr[int32](30),
	// 				PeriodSeconds: to.Ptr[int32](10),
	// 				ProbeAction: &armappplatform.HTTPGetAction{
	// 					Type: to.Ptr(armappplatform.ProbeActionTypeHTTPGetAction),
	// 					Path: to.Ptr("/health"),
	// 					Scheme: to.Ptr(armappplatform.HTTPSchemeTypeHTTP),
	// 				},
	// 			},
	// 			ResourceRequests: &armappplatform.ResourceRequests{
	// 				CPU: to.Ptr("1000m"),
	// 				Memory: to.Ptr("3Gi"),
	// 			},
	// 			TerminationGracePeriodSeconds: to.Ptr[int32](30),
	// 		},
	// 		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

JavaScript

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

/**
 * This sample demonstrates how to Create a new Deployment or update an exiting Deployment.
 *
 * @summary Create a new Deployment or update an exiting Deployment.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_CreateOrUpdate.json
 */
async function deploymentsCreateOrUpdate() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
  const serviceName = "myservice";
  const appName = "myapp";
  const deploymentName = "mydeployment";
  const deploymentResource = {
    properties: {
      deploymentSettings: {
        addonConfigs: {
          applicationConfigurationService: { patterns: ["mypattern"] },
        },
        apms: [
          {
            resourceId:
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights",
          },
        ],
        environmentVariables: { env: "test" },
        livenessProbe: {
          disableProbe: false,
          failureThreshold: 3,
          initialDelaySeconds: 30,
          periodSeconds: 10,
          probeAction: {
            type: "HTTPGetAction",
            path: "/health",
            scheme: "HTTP",
          },
        },
        readinessProbe: {
          disableProbe: false,
          failureThreshold: 3,
          initialDelaySeconds: 30,
          periodSeconds: 10,
          probeAction: {
            type: "HTTPGetAction",
            path: "/health",
            scheme: "HTTP",
          },
        },
        resourceRequests: { cpu: "1000m", memory: "3Gi" },
        startupProbe: {
          disableProbe: false,
        },
        terminationGracePeriodSeconds: 30,
      },
      instances: [],
      source: {
        type: "Source",
        artifactSelector: "sub-module-1",
        relativePath:
          "resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc",
        version: "1.0",
      },
    },
    sku: { name: "S0", capacity: 1, tier: "Standard" },
  };
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const result = await client.deployments.beginCreateOrUpdateAndWait(
    resourceGroupName,
    serviceName,
    appName,
    deploymentName,
    deploymentResource,
  );
  console.log(result);
}

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:

201

{
  "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"
        }
      ],
      "terminationGracePeriodSeconds": 30,
      "livenessProbe": {
        "disableProbe": false,
        "initialDelaySeconds": 30,
        "periodSeconds": 10,
        "failureThreshold": 3,
        "probeAction": {
          "type": "HTTPGetAction",
          "path": "/health",
          "scheme": "HTTP"
        }
      },
      "readinessProbe": {
        "disableProbe": false,
        "initialDelaySeconds": 30,
        "periodSeconds": 10,
        "failureThreshold": 3,
        "probeAction": {
          "type": "HTTPGetAction",
          "path": "/health",
          "scheme": "HTTP"
        }
      },
      "startupProbe": null
    },
    "provisioningState": "Creating",
    "status": "Running",
    "active": false,
    "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"
}

Status code:

200

{
  "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"
        }
      ],
      "terminationGracePeriodSeconds": 30,
      "livenessProbe": {
        "disableProbe": false,
        "initialDelaySeconds": 30,
        "periodSeconds": 10,
        "failureThreshold": 3,
        "probeAction": {
          "type": "HTTPGetAction",
          "path": "/health",
          "scheme": "HTTP"
        }
      },
      "readinessProbe": {
        "disableProbe": false,
        "initialDelaySeconds": 30,
        "periodSeconds": 10,
        "failureThreshold": 3,
        "probeAction": {
          "type": "HTTPGetAction",
          "path": "/health",
          "scheme": "HTTP"
        }
      },
      "startupProbe": null
    },
    "provisioningState": "Succeeded",
    "status": "Running",
    "active": false,
    "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"
}

Status code:

202

{
  "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"
        }
      ],
      "terminationGracePeriodSeconds": 30,
      "livenessProbe": {
        "disableProbe": false,
        "initialDelaySeconds": 30,
        "periodSeconds": 10,
        "failureThreshold": 3,
        "probeAction": {
          "type": "HTTPGetAction",
          "path": "/health",
          "scheme": "HTTP"
        }
      },
      "readinessProbe": {
        "disableProbe": false,
        "initialDelaySeconds": 30,
        "periodSeconds": 10,
        "failureThreshold": 3,
        "probeAction": {
          "type": "HTTPGetAction",
          "path": "/health",
          "scheme": "HTTP"
        }
      },
      "startupProbe": null
    },
    "provisioningState": "Updating",
    "status": "Running",
    "active": false,
    "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"
}

Deployments_CreateOrUpdate_CustomContainer

Sample Request

HTTP

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

{
  "properties": {
    "source": {
      "type": "Container",
      "customContainer": {
        "server": "myacr.azurecr.io",
        "containerImage": "myContainerImage:v1",
        "command": [
          "/bin/sh"
        ],
        "args": [
          "-c",
          "while true; do echo hello; sleep 10;done"
        ],
        "imageRegistryCredential": {
          "username": "myUsername",
          "password": "myPassword"
        },
        "languageFramework": "springboot"
      }
    },
    "deploymentSettings": {
      "resourceRequests": {
        "cpu": "1000m",
        "memory": "3Gi"
      },
      "environmentVariables": {
        "env": "test"
      },
      "terminationGracePeriodSeconds": 30,
      "livenessProbe": {
        "disableProbe": false,
        "initialDelaySeconds": 30,
        "periodSeconds": 10,
        "failureThreshold": 3,
        "probeAction": {
          "type": "HTTPGetAction",
          "path": "/health",
          "scheme": "HTTP"
        }
      },
      "readinessProbe": {
        "disableProbe": false,
        "initialDelaySeconds": 30,
        "periodSeconds": 10,
        "failureThreshold": 3,
        "probeAction": {
          "type": "HTTPGetAction",
          "path": "/health",
          "scheme": "HTTP"
        }
      },
      "startupProbe": null
    },
    "instances": null
  }
}

Java

import com.azure.resourcemanager.appplatform.fluent.models.DeploymentResourceInner;
import com.azure.resourcemanager.appplatform.models.CustomContainer;
import com.azure.resourcemanager.appplatform.models.CustomContainerUserSourceInfo;
import com.azure.resourcemanager.appplatform.models.DeploymentResourceProperties;
import com.azure.resourcemanager.appplatform.models.DeploymentSettings;
import com.azure.resourcemanager.appplatform.models.HttpGetAction;
import com.azure.resourcemanager.appplatform.models.HttpSchemeType;
import com.azure.resourcemanager.appplatform.models.ImageRegistryCredential;
import com.azure.resourcemanager.appplatform.models.Probe;
import com.azure.resourcemanager.appplatform.models.ResourceRequests;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Deployments CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/
     * Deployments_CreateOrUpdate_CustomContainer.json
     */
    /**
     * Sample code: Deployments_CreateOrUpdate_CustomContainer.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void deploymentsCreateOrUpdateCustomContainer(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getDeployments()
            .createOrUpdate("myResourceGroup", "myservice", "myapp", "mydeployment",
                new DeploymentResourceInner()
                    .withProperties(new DeploymentResourceProperties()
                        .withSource(new CustomContainerUserSourceInfo().withCustomContainer(new CustomContainer()
                            .withServer("myacr.azurecr.io").withContainerImage("myContainerImage:v1")
                            .withCommand(Arrays.asList("/bin/sh"))
                            .withArgs(Arrays.asList("-c", "while true; do echo hello; sleep 10;done"))
                            .withImageRegistryCredential(new ImageRegistryCredential().withUsername("myUsername")
                                .withPassword("fakeTokenPlaceholder"))
                            .withLanguageFramework("springboot")))
                        .withDeploymentSettings(new DeploymentSettings()
                            .withResourceRequests(new ResourceRequests().withCpu("1000m").withMemory("3Gi"))
                            .withEnvironmentVariables(mapOf("env", "test"))
                            .withLivenessProbe(new Probe()
                                .withProbeAction(
                                    new HttpGetAction().withPath("/health").withScheme(HttpSchemeType.HTTP))
                                .withDisableProbe(false).withInitialDelaySeconds(30).withPeriodSeconds(10)
                                .withFailureThreshold(3))
                            .withReadinessProbe(new Probe()
                                .withProbeAction(
                                    new HttpGetAction().withPath("/health").withScheme(HttpSchemeType.HTTP))
                                .withDisableProbe(false).withInitialDelaySeconds(30).withPeriodSeconds(10)
                                .withFailureThreshold(3))
                            .withTerminationGracePeriodSeconds(30))),
                com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.appplatform import AppPlatformManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appplatform
# USAGE
    python deployments_create_or_update_custom_container.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.begin_create_or_update(
        resource_group_name="myResourceGroup",
        service_name="myservice",
        app_name="myapp",
        deployment_name="mydeployment",
        deployment_resource={
            "properties": {
                "deploymentSettings": {
                    "environmentVariables": {"env": "test"},
                    "livenessProbe": {
                        "disableProbe": False,
                        "failureThreshold": 3,
                        "initialDelaySeconds": 30,
                        "periodSeconds": 10,
                        "probeAction": {"path": "/health", "scheme": "HTTP", "type": "HTTPGetAction"},
                    },
                    "readinessProbe": {
                        "disableProbe": False,
                        "failureThreshold": 3,
                        "initialDelaySeconds": 30,
                        "periodSeconds": 10,
                        "probeAction": {"path": "/health", "scheme": "HTTP", "type": "HTTPGetAction"},
                    },
                    "resourceRequests": {"cpu": "1000m", "memory": "3Gi"},
                    "startupProbe": None,
                    "terminationGracePeriodSeconds": 30,
                },
                "instances": None,
                "source": {
                    "customContainer": {
                        "args": ["-c", "while true; do echo hello; sleep 10;done"],
                        "command": ["/bin/sh"],
                        "containerImage": "myContainerImage:v1",
                        "imageRegistryCredential": {"password": "myPassword", "username": "myUsername"},
                        "languageFramework": "springboot",
                        "server": "myacr.azurecr.io",
                    },
                    "type": "Container",
                },
            }
        },
    ).result()
    print(response)


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

Go

package armappplatform_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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_CreateOrUpdate_CustomContainer.json
func ExampleDeploymentsClient_BeginCreateOrUpdate_deploymentsCreateOrUpdateCustomContainer() {
	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)
	}
	poller, err := clientFactory.NewDeploymentsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "myapp", "mydeployment", armappplatform.DeploymentResource{
		Properties: &armappplatform.DeploymentResourceProperties{
			DeploymentSettings: &armappplatform.DeploymentSettings{
				EnvironmentVariables: map[string]*string{
					"env": to.Ptr("test"),
				},
				LivenessProbe: &armappplatform.Probe{
					DisableProbe:        to.Ptr(false),
					FailureThreshold:    to.Ptr[int32](3),
					InitialDelaySeconds: to.Ptr[int32](30),
					PeriodSeconds:       to.Ptr[int32](10),
					ProbeAction: &armappplatform.HTTPGetAction{
						Type:   to.Ptr(armappplatform.ProbeActionTypeHTTPGetAction),
						Path:   to.Ptr("/health"),
						Scheme: to.Ptr(armappplatform.HTTPSchemeTypeHTTP),
					},
				},
				ReadinessProbe: &armappplatform.Probe{
					DisableProbe:        to.Ptr(false),
					FailureThreshold:    to.Ptr[int32](3),
					InitialDelaySeconds: to.Ptr[int32](30),
					PeriodSeconds:       to.Ptr[int32](10),
					ProbeAction: &armappplatform.HTTPGetAction{
						Type:   to.Ptr(armappplatform.ProbeActionTypeHTTPGetAction),
						Path:   to.Ptr("/health"),
						Scheme: to.Ptr(armappplatform.HTTPSchemeTypeHTTP),
					},
				},
				ResourceRequests: &armappplatform.ResourceRequests{
					CPU:    to.Ptr("1000m"),
					Memory: to.Ptr("3Gi"),
				},
				TerminationGracePeriodSeconds: to.Ptr[int32](30),
			},
			Source: &armappplatform.CustomContainerUserSourceInfo{
				Type: to.Ptr("Container"),
				CustomContainer: &armappplatform.CustomContainer{
					Args: []*string{
						to.Ptr("-c"),
						to.Ptr("while true; do echo hello; sleep 10;done")},
					Command: []*string{
						to.Ptr("/bin/sh")},
					ContainerImage: to.Ptr("myContainerImage:v1"),
					ImageRegistryCredential: &armappplatform.ImageRegistryCredential{
						Password: to.Ptr("myPassword"),
						Username: to.Ptr("myUsername"),
					},
					LanguageFramework: to.Ptr("springboot"),
					Server:            to.Ptr("myacr.azurecr.io"),
				},
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DeploymentResource = 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(false),
	// 		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"),
	// 			},
	// 			LivenessProbe: &armappplatform.Probe{
	// 				DisableProbe: to.Ptr(false),
	// 				FailureThreshold: to.Ptr[int32](3),
	// 				InitialDelaySeconds: to.Ptr[int32](30),
	// 				PeriodSeconds: to.Ptr[int32](10),
	// 				ProbeAction: &armappplatform.HTTPGetAction{
	// 					Type: to.Ptr(armappplatform.ProbeActionTypeHTTPGetAction),
	// 					Path: to.Ptr("/health"),
	// 					Scheme: to.Ptr(armappplatform.HTTPSchemeTypeHTTP),
	// 				},
	// 			},
	// 			ReadinessProbe: &armappplatform.Probe{
	// 				DisableProbe: to.Ptr(false),
	// 				FailureThreshold: to.Ptr[int32](3),
	// 				InitialDelaySeconds: to.Ptr[int32](30),
	// 				PeriodSeconds: to.Ptr[int32](10),
	// 				ProbeAction: &armappplatform.HTTPGetAction{
	// 					Type: to.Ptr(armappplatform.ProbeActionTypeHTTPGetAction),
	// 					Path: to.Ptr("/health"),
	// 					Scheme: to.Ptr(armappplatform.HTTPSchemeTypeHTTP),
	// 				},
	// 			},
	// 			ResourceRequests: &armappplatform.ResourceRequests{
	// 				CPU: to.Ptr("1000m"),
	// 				Memory: to.Ptr("3Gi"),
	// 			},
	// 			TerminationGracePeriodSeconds: to.Ptr[int32](30),
	// 		},
	// 		Instances: []*armappplatform.DeploymentInstance{
	// 			{
	// 				Name: to.Ptr("instance1"),
	// 				DiscoveryStatus: to.Ptr("N/A"),
	// 				StartTime: to.Ptr("2020-08-26T01:55:02Z"),
	// 				Status: to.Ptr("Running"),
	// 		}},
	// 		ProvisioningState: to.Ptr(armappplatform.DeploymentResourceProvisioningStateSucceeded),
	// 		Source: &armappplatform.CustomContainerUserSourceInfo{
	// 			Type: to.Ptr("Container"),
	// 			CustomContainer: &armappplatform.CustomContainer{
	// 				ContainerImage: to.Ptr("myContainerImage:v1"),
	// 				ImageRegistryCredential: &armappplatform.ImageRegistryCredential{
	// 					Password: to.Ptr(""),
	// 					Username: to.Ptr("myUsername"),
	// 				},
	// 				LanguageFramework: to.Ptr("springboot"),
	// 				Server: to.Ptr("myacr.azurecr.io"),
	// 			},
	// 		},
	// 		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

JavaScript

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

/**
 * This sample demonstrates how to Create a new Deployment or update an exiting Deployment.
 *
 * @summary Create a new Deployment or update an exiting Deployment.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_CreateOrUpdate_CustomContainer.json
 */
async function deploymentsCreateOrUpdateCustomContainer() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
  const serviceName = "myservice";
  const appName = "myapp";
  const deploymentName = "mydeployment";
  const deploymentResource = {
    properties: {
      deploymentSettings: {
        environmentVariables: { env: "test" },
        livenessProbe: {
          disableProbe: false,
          failureThreshold: 3,
          initialDelaySeconds: 30,
          periodSeconds: 10,
          probeAction: {
            type: "HTTPGetAction",
            path: "/health",
            scheme: "HTTP",
          },
        },
        readinessProbe: {
          disableProbe: false,
          failureThreshold: 3,
          initialDelaySeconds: 30,
          periodSeconds: 10,
          probeAction: {
            type: "HTTPGetAction",
            path: "/health",
            scheme: "HTTP",
          },
        },
        resourceRequests: { cpu: "1000m", memory: "3Gi" },
        startupProbe: {
          disableProbe: false,
        },
        terminationGracePeriodSeconds: 30,
      },
      instances: [],
      source: {
        type: "Container",
        customContainer: {
          args: ["-c", "while true; do echo hello; sleep 10;done"],
          command: ["/bin/sh"],
          containerImage: "myContainerImage:v1",
          imageRegistryCredential: {
            password: "myPassword",
            username: "myUsername",
          },
          languageFramework: "springboot",
          server: "myacr.azurecr.io",
        },
      },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const result = await client.deployments.beginCreateOrUpdateAndWait(
    resourceGroupName,
    serviceName,
    appName,
    deploymentName,
    deploymentResource,
  );
  console.log(result);
}

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:

201

{
  "properties": {
    "source": {
      "type": "Container",
      "customContainer": {
        "server": "myacr.azurecr.io",
        "containerImage": "myContainerImage:v1",
        "imageRegistryCredential": {
          "username": "myUsername",
          "password": ""
        },
        "languageFramework": "springboot"
      }
    },
    "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"
        }
      ],
      "terminationGracePeriodSeconds": 30,
      "livenessProbe": {
        "disableProbe": false,
        "initialDelaySeconds": 30,
        "periodSeconds": 10,
        "failureThreshold": 3,
        "probeAction": {
          "type": "HTTPGetAction",
          "path": "/health",
          "scheme": "HTTP"
        }
      },
      "readinessProbe": {
        "disableProbe": false,
        "initialDelaySeconds": 30,
        "periodSeconds": 10,
        "failureThreshold": 3,
        "probeAction": {
          "type": "HTTPGetAction",
          "path": "/health",
          "scheme": "HTTP"
        }
      },
      "startupProbe": null
    },
    "provisioningState": "Creating",
    "status": "Running",
    "active": false,
    "instances": [
      {
        "name": "instance1",
        "status": "Running",
        "discoveryStatus": "N/A",
        "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"
}

Status code:

200

{
  "properties": {
    "source": {
      "type": "Container",
      "customContainer": {
        "server": "myacr.azurecr.io",
        "containerImage": "myContainerImage:v1",
        "imageRegistryCredential": {
          "username": "myUsername",
          "password": ""
        },
        "languageFramework": "springboot"
      }
    },
    "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"
        }
      ],
      "terminationGracePeriodSeconds": 30,
      "livenessProbe": {
        "disableProbe": false,
        "initialDelaySeconds": 30,
        "periodSeconds": 10,
        "failureThreshold": 3,
        "probeAction": {
          "type": "HTTPGetAction",
          "path": "/health",
          "scheme": "HTTP"
        }
      },
      "readinessProbe": {
        "disableProbe": false,
        "initialDelaySeconds": 30,
        "periodSeconds": 10,
        "failureThreshold": 3,
        "probeAction": {
          "type": "HTTPGetAction",
          "path": "/health",
          "scheme": "HTTP"
        }
      },
      "startupProbe": null
    },
    "provisioningState": "Succeeded",
    "status": "Running",
    "active": false,
    "instances": [
      {
        "name": "instance1",
        "status": "Running",
        "discoveryStatus": "N/A",
        "startTime": "2020-08-26T01:55:02Z"
      }
    ]
  },
  "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"
  },
  "sku": {
    "name": "S0",
    "tier": "Standard",
    "capacity": 1
  },
  "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"
}

Status code:

202

{
  "properties": {
    "source": {
      "type": "Container",
      "customContainer": {
        "server": "myacr.azurecr.io",
        "containerImage": "myContainerImage:v1",
        "imageRegistryCredential": {
          "username": "myUsername",
          "password": ""
        },
        "languageFramework": "springboot"
      }
    },
    "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"
        }
      ],
      "terminationGracePeriodSeconds": 30,
      "livenessProbe": {
        "disableProbe": false,
        "initialDelaySeconds": 30,
        "periodSeconds": 10,
        "failureThreshold": 3,
        "probeAction": {
          "type": "HTTPGetAction",
          "path": "/health",
          "scheme": "HTTP"
        }
      },
      "readinessProbe": {
        "disableProbe": false,
        "initialDelaySeconds": 30,
        "periodSeconds": 10,
        "failureThreshold": 3,
        "probeAction": {
          "type": "HTTPGetAction",
          "path": "/health",
          "scheme": "HTTP"
        }
      },
      "startupProbe": null
    },
    "provisioningState": "Updating",
    "status": "Running",
    "active": false,
    "instances": [
      {
        "name": "instance1",
        "status": "Running",
        "discoveryStatus": "N/A",
        "startTime": "2020-08-26T01:55:02Z"
      }
    ]
  },
  "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"
  },
  "sku": {
    "name": "S0",
    "tier": "Standard",
    "capacity": 1
  },
  "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"
}

Definitionen

Name	Beschreibung
ApmReference	Ein Verweis auf die APM
BuildResultUserSourceInfo	Verweis auf ein Buildergebnis
CloudError	Eine Fehlerantwort vom Dienst.
CloudErrorBody	Eine Fehlerantwort vom Dienst.
ContainerProbeSettings	Einstellungen für Den Container-Liveness- und Bereitschaftstest
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
CustomContainer	Benutzerdefinierte Containernutzlast
CustomContainerUserSourceInfo	Informationen zur Benutzerdefinierten Containerbenutzerquelle
DeploymentInstance	Bereitstellungsnutzlast instance
DeploymentResource	Ressourcennutzlast für die Bereitstellung
DeploymentResourceProperties	Nutzlast der Bereitstellungsressourceneigenschaften
DeploymentResourceProvisioningState	Bereitstellungsstatus der Bereitstellung
DeploymentResourceStatus	Status der Bereitstellung
DeploymentSettings	Nutzlast der Bereitstellungseinstellungen
ExecAction	ExecAction beschreibt eine Aktion "Im Container ausführen".
HTTPGetAction	HTTPGetAction beschreibt eine Aktion, die auf HTTP Get-Anforderungen basiert.
HTTPSchemeType	Schema, das zum Herstellen einer Verbindung mit dem Host verwendet werden soll. Der Standardwert ist HTTP. Mögliche Enumerationswerte: "HTTP" bedeutet, dass das verwendete Schema http:// "HTTPS" bedeutet, dass das verwendete Schema https://
ImageRegistryCredential	Anmeldeinformationen der Imageregistrierung
lastModifiedByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.
Probe	Der Test beschreibt eine Integritätsprüfung, die für eine App-Instanz ausgeführt werden soll, um zu bestimmen, ob sie aktiv ist oder bereit ist, Datenverkehr zu empfangen.
ResourceRequests	Anforderungsnutzlast für Bereitstellungsressourcen
Sku	SKU von Azure Spring Apps
SystemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
TCPSocketAction	TCPSocketAction beschreibt eine Aktion, die auf dem Öffnen eines Sockets basiert.

ApmReference

Ein Verweis auf die APM

Name	Typ	Beschreibung
resourceId	string	Ressourcen-ID des APM

BuildResultUserSourceInfo

Verweis auf ein Buildergebnis

Name	Typ	Beschreibung
buildResultId	string	Ressourcen-ID eines vorhandenen erfolgreichen Buildergebnisses unter demselben Spring instance.
type	string: BuildResult	Typ der hochgeladenen Quelle
version	string	Version der Quelle

CloudError

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
error	CloudErrorBody	Eine Fehlerantwort vom Dienst.

CloudErrorBody

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
target	string	Das Ziel des bestimmten Fehlers. Beispiel: Der Name der -Eigenschaft, die einen Fehler aufweist.

ContainerProbeSettings

Einstellungen für Den Container-Liveness- und Bereitschaftstest

Name	Typ	Beschreibung
disableProbe	boolean	Gibt an, ob der Liveness- und Bereitschaftstest deaktiviert wird.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

CustomContainer

Benutzerdefinierte Containernutzlast

Name	Typ	Beschreibung
args	string[]	Argumente für den Einstiegspunkt. Die CMD des Docker-Images wird verwendet, wenn dies nicht bereitgestellt wird.
command	string[]	Entrypoint-Array. Wird nicht innerhalb einer Shell ausgeführt. Der ENTRYPOINT des Docker-Images wird verwendet, wenn dies nicht bereitgestellt wird.
containerImage	string	Containerimage des benutzerdefinierten Containers. Dies sollte in Form von sein: ohne den Servernamen der Registrierung.
imageRegistryCredential	ImageRegistryCredential	Anmeldeinformationen der Imageregistrierung
languageFramework	string	Sprachframework des hochgeladenen Containerimages. Unterstützte Werte: "springboot", "", null.
server	string	Der Name der Registrierung, die das Containerimage enthält

CustomContainerUserSourceInfo

Informationen zur Benutzerdefinierten Containerbenutzerquelle

Name	Typ	Beschreibung
customContainer	CustomContainer	Benutzerdefinierte Containernutzlast
type	string: Container	Typ der hochgeladenen Quelle
version	string	Version der Quelle

DeploymentInstance

Bereitstellungsnutzlast instance

Name	Typ	Beschreibung
discoveryStatus	string	Ermittlung status des Bereitstellungs-instance
name	string	Name des Bereitstellungs-instance
reason	string	Fehlerursache der Bereitstellung instance
startTime	string	Startzeit der Bereitstellung instance
status	string	Status der bereitstellungs-instance
zone	string	Informationen zur Verfügbarkeitszone der bereitstellungs instance

DeploymentResource

Ressourcennutzlast für die Bereitstellung

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource.
name	string	Der Name der Ressource.
properties	DeploymentResourceProperties	Eigenschaften der Bereitstellungsressource
sku	Sku	SKU der Bereitstellungsressource
systemData	SystemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
type	string	Der Typ der Ressource.

DeploymentResourceProperties

Nutzlast der Bereitstellungsressourceneigenschaften

Name	Typ	Beschreibung
active	boolean	Gibt an, ob die Bereitstellung aktiv ist.
deploymentSettings	DeploymentSettings	Bereitstellungseinstellungen der Bereitstellung
instances	DeploymentInstance[]	Eine Sammlung von Instanzen gehört zur Bereitstellung.
provisioningState	DeploymentResourceProvisioningState	Bereitstellungsstatus der Bereitstellung
source	UserSourceInfo: BuildResultUserSourceInfo CustomContainerUserSourceInfo	Die Quellinformationen der Bereitstellung wurden hochgeladen.
status	DeploymentResourceStatus	Status der Bereitstellung

DeploymentResourceProvisioningState

Bereitstellungsstatus der Bereitstellung

Name	Typ	Beschreibung
Creating	string
Failed	string
Succeeded	string
Updating	string

DeploymentResourceStatus

Status der Bereitstellung

Name	Typ	Beschreibung
Running	string
Stopped	string

DeploymentSettings

Nutzlast der Bereitstellungseinstellungen

Name	Typ	Standardwert	Beschreibung
addonConfigs	object		Sammlung von Addons
apms	ApmReference[]		Sammlung von ApmReferences
containerProbeSettings	ContainerProbeSettings		Einstellungen für Container für Live- und Bereitschaftstests
environmentVariables	object		Sammlung von Umgebungsvariablen
livenessProbe	Probe		Regelmäßiger Test der App-Instanz-Live. Die App-Instanz wird neu gestartet, wenn der Test fehlschlägt. Weitere Informationen: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
readinessProbe	Probe		Regelmäßige Überprüfung der Bereitschaft des App-Instanzdiensts. Die App-Instanz wird von Dienstendpunkten entfernt, wenn der Test fehlschlägt. Weitere Informationen: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
resourceRequests	ResourceRequests		Die angeforderte Ressourcenmenge für die erforderliche CPU und den erforderlichen Arbeitsspeicher. Es wird empfohlen, dass die Verwendung dieses Felds zur Darstellung der erforderlichen CPU und des erforderlichen Arbeitsspeichers, des alten Felds cpu und memoryInGB später als veraltet gilt.
startupProbe	Probe		StartupProbe gibt an, dass die App-Instanz erfolgreich initialisiert wurde. Wenn angegeben, werden keine weiteren Tests ausgeführt, bis dies erfolgreich abgeschlossen ist. Wenn dieser Test fehlschlägt, wird der Pod neu gestartet, so als ob livenessProbe fehlgeschlagen wäre. Dies kann verwendet werden, um andere Testparameter zu Beginn des Lebenszyklus einer App-Instanz bereitzustellen, wenn das Laden von Daten oder das Aufwärmen eines Caches sehr lange dauern kann, als während des betriebsinternen Betriebs. Dies kann nicht aktualisiert werden. Weitere Informationen: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
terminationGracePeriodSeconds	integer	90	Optionale Dauer in Sekunden, die die App-Instanz ordnungsgemäß beenden muss. Kann in der Löschanforderung verringert werden. Der Wert muss eine nicht negative ganze Zahl sein. Der Wert 0 gibt an, dass sofort über das Kill-Signal angehalten wird (keine Gelegenheit zum Herunterfahren). Wenn dieser Wert gleich null ist, wird stattdessen der standardmäßige Nachfristzeitraum verwendet. Die Karenzzeit ist die Dauer in Sekunden, nachdem die in der App-Instanz ausgeführten Prozesse ein Beendigungssignal gesendet haben, und der Zeitpunkt, zu dem die Prozesse mit einem Kill-Signal erzwungen angehalten werden. Legen Sie für diesen Wert eine längere Zeit als die erwartete Bereinigungszeit für Ihren Prozess fest. Der Standardwert ist 90 Sekunden.

ExecAction

ExecAction beschreibt eine Aktion "Im Container ausführen".

Name	Typ	Beschreibung
command	string[]	Der Befehl ist die Befehlszeile, die im Container ausgeführt werden soll. Das Arbeitsverzeichnis für den Befehl ist stamm ('/') im Dateisystem des Containers. Der Befehl wird nicht innerhalb einer Shell ausgeführt, sodass herkömmliche Shellanweisungen ('|' usw.) nicht funktionieren. Um eine Shell zu verwenden, müssen Sie diese Shell explizit aufrufen. Exit status von 0 wird als lebend/fehlerfrei behandelt und ungleich Null ist fehlerhaft.
type	string: ExecAction	Der Typ der Aktion, die zum Durchführen der Integritätsprüfung ausgeführt werden soll.

HTTPGetAction

HTTPGetAction beschreibt eine Aktion, die auf HTTP Get-Anforderungen basiert.

Name	Typ	Beschreibung
path	string	Pfad zum Zugriff auf den HTTP-Server.
scheme	HTTPSchemeType	Schema, das zum Herstellen einer Verbindung mit dem Host verwendet werden soll. Der Standardwert ist HTTP. Mögliche Enumerationswerte: "HTTP" bedeutet, dass das verwendete Schema http:// "HTTPS" bedeutet, dass das verwendete Schema https://
type	string: HTTPGetAction	Der Typ der Aktion, die zum Durchführen der Integritätsprüfung ausgeführt werden soll.

HTTPSchemeType

Schema, das zum Herstellen einer Verbindung mit dem Host verwendet werden soll. Der Standardwert ist HTTP.

Mögliche Enumerationswerte:

• "HTTP" bedeutet, dass das verwendete Schema http://
• "HTTPS" bedeutet, dass das verwendete Schema https://

Name	Typ	Beschreibung
HTTP	string
HTTPS	string

ImageRegistryCredential

Anmeldeinformationen der Imageregistrierung

Name	Typ	Beschreibung
password	string	Das Kennwort der Anmeldeinformationen für die Imageregistrierung
username	string	Der Benutzername der Anmeldeinformationen für die Imageregistrierung

lastModifiedByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

Probe

Der Test beschreibt eine Integritätsprüfung, die für eine App-Instanz ausgeführt werden soll, um zu bestimmen, ob sie aktiv ist oder bereit ist, Datenverkehr zu empfangen.

Name	Typ	Standardwert	Beschreibung
disableProbe	boolean	False	Geben Sie an, ob der Test deaktiviert ist.
failureThreshold	integer		Minimale aufeinanderfolgende Fehler, damit der Test nach dem Erfolgreichen als fehlgeschlagen gilt. Der Mindestwert ist 1.
initialDelaySeconds	integer		Anzahl der Sekunden nach dem Starten der App-Instanz, bevor Tests initiiert werden. Weitere Informationen: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
periodSeconds	integer		Gibt an, wie häufig (in Sekunden) ein Test durchgeführt werden soll. Der Mindestwert ist 1.
probeAction	ProbeAction: ExecAction HTTPGetAction TCPSocketAction		Die Aktion des Tests.
successThreshold	integer		Minimale aufeinanderfolgende Erfolge, damit der Test nach einem Fehler als erfolgreich betrachtet wird. Muss 1 für Liveness und Start sein. Der Mindestwert ist 1.
timeoutSeconds	integer		Anzahl der Sekunden, nach denen das Zeitüberschreitungsintervall für den Test aufgetreten ist. Der Mindestwert ist 1.

ResourceRequests

Anforderungsnutzlast für Bereitstellungsressourcen

Name	Typ	Beschreibung
cpu	string	Erforderliche CPU. 1 Kern kann durch 1 oder 1000m dargestellt werden. Dies sollte 500m oder 1 für den Tarif Basic und {500m, 1, 2, 3, 4} für den Tarif Standard sein.
memory	string	Erforderlicher Arbeitsspeicher. 1 GB kann durch 1Gi oder 1024Mi dargestellt werden. Dies sollte {512Mi, 1Gi, 2Gi} für den Tarif Basic und {512Mi, 1Gi, 2Gi, ..., 8Gi} für den Tarif Standard sein.

Sku

SKU von Azure Spring Apps

Name	Typ	Standardwert	Beschreibung
capacity	integer		Aktuelle Kapazität der Zielressource
name	string	S0	Name der SKU
tier	string	Standard	Ebene der SKU

SystemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der Ressourcenänderung (UTC).
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	lastModifiedByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

TCPSocketAction

TCPSocketAction beschreibt eine Aktion, die auf dem Öffnen eines Sockets basiert.

Name	Typ	Beschreibung
type	string: TCPSocketAction	Der Typ der Aktion, die zum Durchführen der Integritätsprüfung ausgeführt werden soll.