Apms - Create Or Update
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 |
---|---|---|---|---|
apm
|
path | True |
string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$ |
The name of the APM |
resource
|
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. |
service
|
path | True |
string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$ |
The name of the Service resource. |
subscription
|
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 |
Properties of an APM |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Success. The response describes the APM updated. |
|
201 Created |
Created. The response describes the new APM created and contains an Azure-AsyncOperation header to query the operation result. |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
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"
}
}
}
Sample response
{
"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"
}
{
"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 |
---|---|
Apm |
Properties of an APM |
Apm |
State of the APM. |
Apm |
APM Resource object |
Cloud |
An error response from the service. |
Cloud |
An error response from the service. |
created |
The type of identity that created the resource. |
last |
The type of identity that last modified the resource. |
System |
Metadata pertaining to creation and last modification of the resource. |
ApmProperties
Properties of an APM
Name | Type | Description |
---|---|---|
properties |
object |
Non-sensitive properties for the APM |
provisioningState |
State of the APM. |
|
secrets |
object |
Sensitive properties for the APM |
type |
string |
APM Type |
ApmProvisioningState
State of the APM.
Value | Description |
---|---|
Creating | |
Updating | |
Succeeded | |
Failed | |
Deleting | |
Canceled |
ApmResource
APM Resource object
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource Id for the resource. |
name |
string |
The name of the resource. |
properties |
Properties of an APM |
|
systemData |
Metadata pertaining to creation and last modification of the resource. |
|
type |
string |
The type of the resource. |
CloudError
An error response from the service.
Name | Type | Description |
---|---|---|
error |
An error response from the service. |
CloudErrorBody
An error response from the service.
Name | Type | Description |
---|---|---|
code |
string |
An identifier for the error. Codes are invariant and are intended to be consumed programmatically. |
details |
A list of additional details about the error. |
|
message |
string |
A message describing the error, intended to be suitable for display in a user interface. |
target |
string |
The target of the particular error. For example, the name of the property in error. |
createdByType
The type of identity that created the resource.
Value | Description |
---|---|
User | |
Application | |
ManagedIdentity | |
Key |
lastModifiedByType
The type of identity that last modified the resource.
Value | Description |
---|---|
User | |
Application | |
ManagedIdentity | |
Key |
SystemData
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 |
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 |
The type of identity that last modified the resource. |