Apms - Create Or Update

Service:: Azure Spring Apps

API Version:: 2023-12-01

Create or update an APM.

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

URI Parameters

Name	In	Required	Type	Description
apmName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	The name of the APM
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.

Request Body

Name	Type	Description
properties	ApmProperties	Properties of an APM

Responses

Name	Type	Description
200 OK	ApmResource	Success. The response describes the APM updated.
201 Created	ApmResource	Created. The response describes the new APM created and contains an Azure-AsyncOperation header to query the operation result.
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

Apms_CreateOrUpdate

Sample request

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

{
  "properties": {
    "type": "ApplicationInsights",
    "properties": {
      "any-string": "any-string",
      "sampling-rate": "12.0"
    },
    "secrets": {
      "connection-string": "XXXXXXXXXXXXXXXXX=XXXXXXXXXXXXX-XXXXXXXXXXXXXXXXXXX;XXXXXXXXXXXXXXXXX=XXXXXXXXXXXXXXXXXXX"
    }
  }
}


import com.azure.resourcemanager.appplatform.fluent.models.ApmResourceInner;
import com.azure.resourcemanager.appplatform.models.ApmProperties;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Apms CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Apms_CreateOrUpdate.
     * json
     */
    /**
     * Sample code: Apms_CreateOrUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void apmsCreateOrUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getApms().createOrUpdate("myResourceGroup", "myservice",
            "myappinsights",
            new ApmResourceInner().withProperties(new ApmProperties().withType("ApplicationInsights")
                .withProperties(mapOf("any-string", "any-string", "sampling-rate", "12.0"))
                .withSecrets(mapOf("connection-string",
                    "XXXXXXXXXXXXXXXXX=XXXXXXXXXXXXX-XXXXXXXXXXXXXXXXXXX;XXXXXXXXXXXXXXXXX=XXXXXXXXXXXXXXXXXXX"))),
            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

from azure.identity import DefaultAzureCredential

from azure.mgmt.appplatform import AppPlatformManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appplatform
# USAGE
    python apms_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.apms.begin_create_or_update(
        resource_group_name="myResourceGroup",
        service_name="myservice",
        apm_name="myappinsights",
        apm_resource={
            "properties": {
                "properties": {"any-string": "any-string", "sampling-rate": "12.0"},
                "secrets": {
                    "connection-string": "XXXXXXXXXXXXXXXXX=XXXXXXXXXXXXX-XXXXXXXXXXXXXXXXXXX;XXXXXXXXXXXXXXXXX=XXXXXXXXXXXXXXXXXXX"
                },
                "type": "ApplicationInsights",
            }
        },
    ).result()
    print(response)


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

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/Apms_CreateOrUpdate.json
func ExampleApmsClient_BeginCreateOrUpdate() {
	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.NewApmsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "myappinsights", armappplatform.ApmResource{
		Properties: &armappplatform.ApmProperties{
			Type: to.Ptr("ApplicationInsights"),
			Properties: map[string]*string{
				"any-string":    to.Ptr("any-string"),
				"sampling-rate": to.Ptr("12.0"),
			},
			Secrets: map[string]*string{
				"connection-string": to.Ptr("XXXXXXXXXXXXXXXXX=XXXXXXXXXXXXX-XXXXXXXXXXXXXXXXXXX;XXXXXXXXXXXXXXXXX=XXXXXXXXXXXXXXXXXXX"),
			},
		},
	}, 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.ApmResource = armappplatform.ApmResource{
	// 	Name: to.Ptr("myappinsights"),
	// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apms"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
	// 	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.ApmProperties{
	// 		Type: to.Ptr("ApplicationInsights"),
	// 		Properties: map[string]*string{
	// 			"any-string": to.Ptr("any-string"),
	// 			"sampling-rate": to.Ptr("12.0"),
	// 		},
	// 	},
	// }
}

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 Create or update an APM.
 *
 * @summary Create or update an APM.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Apms_CreateOrUpdate.json
 */
async function apmsCreateOrUpdate() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
  const serviceName = "myservice";
  const apmName = "myappinsights";
  const apmResource = {
    properties: {
      type: "ApplicationInsights",
      properties: { anyString: "any-string", samplingRate: "12.0" },
      secrets: {
        connectionString:
          "XXXXXXXXXXXXXXXXX=XXXXXXXXXXXXX-XXXXXXXXXXXXXXXXXXX;XXXXXXXXXXXXXXXXX=XXXXXXXXXXXXXXXXXXX",
      },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const result = await client.apms.beginCreateOrUpdateAndWait(
    resourceGroupName,
    serviceName,
    apmName,
    apmResource,
  );
  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:: 200

{
  "properties": {
    "type": "ApplicationInsights",
    "properties": {
      "any-string": "any-string",
      "sampling-rate": "12.0"
    }
  },
  "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/apms",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights",
  "name": "myappinsights"
}

Status code:: 201

{
  "properties": {
    "type": "ApplicationInsights",
    "properties": {
      "any-string": "any-string",
      "sampling-rate": "12.0"
    }
  },
  "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/apms",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights",
  "name": "myappinsights"
}

Definitions

Name	Description
ApmProperties	Properties of an APM
ApmProvisioningState	State of the APM.
ApmResource	APM Resource object
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
createdByType	The type of identity that created the resource.
lastModifiedByType	The type of identity that last modified the resource.
SystemData	Metadata pertaining to creation and last modification of the resource.

ApmProperties

Object

Properties of an APM

Name	Type	Description
properties	object	Non-sensitive properties for the APM
provisioningState	ApmProvisioningState	State of the APM.
secrets	object	Sensitive properties for the APM
type	string	APM Type

ApmProvisioningState

Enumeration

State of the APM.

Value	Description
Creating
Updating
Succeeded
Failed
Deleting
Canceled

ApmResource

Object

APM Resource object

Name	Type	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
properties	ApmProperties	Properties of an APM
systemData	SystemData	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

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.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

lastModifiedByType

Enumeration

The type of identity that last modified the resource.

Value	Description
User
Application
ManagedIdentity
Key

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.

Share via

Apms - Create Or Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Apms_CreateOrUpdate

Sample request

Sample response

Definitions

ApmProperties

ApmProvisioningState

ApmResource

CloudError

CloudErrorBody

createdByType

lastModifiedByType

SystemData