Microsoft.AppPlatform Spring/applicationAccelerators/customizedAccelerators 2023-01-01-preview
Bicep resource definition
The Spring/applicationAccelerators/customizedAccelerators resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AppPlatform/Spring/applicationAccelerators/customizedAccelerators resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AppPlatform/Spring/applicationAccelerators/customizedAccelerators@2023-01-01-preview' = {
name: 'string'
sku: {
capacity: int
name: 'string'
tier: 'string'
}
parent: resourceSymbolicName
properties: {
acceleratorTags: [
'string'
]
description: 'string'
displayName: 'string'
gitRepository: {
authSetting: {
authType: 'string'
// For remaining properties, see AcceleratorAuthSetting objects
}
branch: 'string'
commit: 'string'
gitTag: 'string'
intervalInSeconds: int
url: 'string'
}
iconUrl: 'string'
}
}
AcceleratorAuthSetting objects
Set the authType property to specify the type of object.
For BasicAuth, use:
authType: 'BasicAuth'
password: 'string'
username: 'string'
For Public, use:
authType: 'Public'
For SSH, use:
authType: 'SSH'
hostKey: 'string'
hostKeyAlgorithm: 'string'
privateKey: 'string'
Property values
Spring/applicationAccelerators/customizedAccelerator...
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
| sku | Sku of the customized accelerator resource | Sku |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: applicationAccelerators |
| properties | Customized accelerator properties payload | CustomizedAcceleratorProperties |
CustomizedAcceleratorProperties
| Name | Description | Value |
|---|---|---|
| acceleratorTags | string[] | |
| description | string | |
| displayName | string | |
| gitRepository | AcceleratorGitRepository (required) | |
| iconUrl | string |
AcceleratorGitRepository
| Name | Description | Value |
|---|---|---|
| authSetting | Properties of the auth setting payload. | AcceleratorAuthSetting (required) |
| branch | Git repository branch to be used. | string |
| commit | Git repository commit to be used. | string |
| gitTag | Git repository tag to be used. | string |
| intervalInSeconds | Interval for checking for updates to Git or image repository. | int |
| url | Git repository URL for the accelerator. | string (required) |
AcceleratorAuthSetting
| Name | Description | Value |
|---|---|---|
| authType | Set the object type | BasicAuth Public SSH (required) |
AcceleratorBasicAuthSetting
| Name | Description | Value |
|---|---|---|
| authType | The type of the auth setting. | 'BasicAuth' (required) |
| password | Password of git repository basic auth. | string |
| username | Username of git repository basic auth. | string (required) |
AcceleratorPublicSetting
| Name | Description | Value |
|---|---|---|
| authType | The type of the auth setting. | 'Public' (required) |
AcceleratorSshSetting
| Name | Description | Value |
|---|---|---|
| authType | The type of the auth setting. | 'SSH' (required) |
| hostKey | Public SSH Key of git repository. | string |
| hostKeyAlgorithm | SSH Key algorithm of git repository. | string |
| privateKey | Private SSH Key algorithm of git repository. | string |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | Current capacity of the target resource | int |
| name | Name of the Sku | string |
| tier | Tier of the Sku | string |
ARM template resource definition
The Spring/applicationAccelerators/customizedAccelerators resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AppPlatform/Spring/applicationAccelerators/customizedAccelerators resource, add the following JSON to your template.
{
"type": "Microsoft.AppPlatform/Spring/applicationAccelerators/customizedAccelerators",
"apiVersion": "2023-01-01-preview",
"name": "string",
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"properties": {
"acceleratorTags": [ "string" ],
"description": "string",
"displayName": "string",
"gitRepository": {
"authSetting": {
"authType": "string"
// For remaining properties, see AcceleratorAuthSetting objects
},
"branch": "string",
"commit": "string",
"gitTag": "string",
"intervalInSeconds": "int",
"url": "string"
},
"iconUrl": "string"
}
}
AcceleratorAuthSetting objects
Set the authType property to specify the type of object.
For BasicAuth, use:
"authType": "BasicAuth",
"password": "string",
"username": "string"
For Public, use:
"authType": "Public"
For SSH, use:
"authType": "SSH",
"hostKey": "string",
"hostKeyAlgorithm": "string",
"privateKey": "string"
Property values
Spring/applicationAccelerators/customizedAccelerator...
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.AppPlatform/Spring/applicationAccelerators/customizedAccelerators' |
| apiVersion | The resource api version | '2023-01-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| sku | Sku of the customized accelerator resource | Sku |
| properties | Customized accelerator properties payload | CustomizedAcceleratorProperties |
CustomizedAcceleratorProperties
| Name | Description | Value |
|---|---|---|
| acceleratorTags | string[] | |
| description | string | |
| displayName | string | |
| gitRepository | AcceleratorGitRepository (required) | |
| iconUrl | string |
AcceleratorGitRepository
| Name | Description | Value |
|---|---|---|
| authSetting | Properties of the auth setting payload. | AcceleratorAuthSetting (required) |
| branch | Git repository branch to be used. | string |
| commit | Git repository commit to be used. | string |
| gitTag | Git repository tag to be used. | string |
| intervalInSeconds | Interval for checking for updates to Git or image repository. | int |
| url | Git repository URL for the accelerator. | string (required) |
AcceleratorAuthSetting
| Name | Description | Value |
|---|---|---|
| authType | Set the object type | BasicAuth Public SSH (required) |
AcceleratorBasicAuthSetting
| Name | Description | Value |
|---|---|---|
| authType | The type of the auth setting. | 'BasicAuth' (required) |
| password | Password of git repository basic auth. | string |
| username | Username of git repository basic auth. | string (required) |
AcceleratorPublicSetting
| Name | Description | Value |
|---|---|---|
| authType | The type of the auth setting. | 'Public' (required) |
AcceleratorSshSetting
| Name | Description | Value |
|---|---|---|
| authType | The type of the auth setting. | 'SSH' (required) |
| hostKey | Public SSH Key of git repository. | string |
| hostKeyAlgorithm | SSH Key algorithm of git repository. | string |
| privateKey | Private SSH Key algorithm of git repository. | string |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | Current capacity of the target resource | int |
| name | Name of the Sku | string |
| tier | Tier of the Sku | string |
Terraform (AzAPI provider) resource definition
The Spring/applicationAccelerators/customizedAccelerators resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AppPlatform/Spring/applicationAccelerators/customizedAccelerators resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AppPlatform/Spring/applicationAccelerators/customizedAccelerators@2023-01-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
acceleratorTags = [
"string"
]
description = "string"
displayName = "string"
gitRepository = {
authSetting = {
authType = "string"
// For remaining properties, see AcceleratorAuthSetting objects
}
branch = "string"
commit = "string"
gitTag = "string"
intervalInSeconds = int
url = "string"
}
iconUrl = "string"
}
sku = {
capacity = int
name = "string"
tier = "string"
}
})
}
AcceleratorAuthSetting objects
Set the authType property to specify the type of object.
For BasicAuth, use:
authType = "BasicAuth"
password = "string"
username = "string"
For Public, use:
authType = "Public"
For SSH, use:
authType = "SSH"
hostKey = "string"
hostKeyAlgorithm = "string"
privateKey = "string"
Property values
Spring/applicationAccelerators/customizedAccelerator...
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.AppPlatform/Spring/applicationAccelerators/customizedAccelerators@2023-01-01-preview" |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: applicationAccelerators |
| sku | Sku of the customized accelerator resource | Sku |
| properties | Customized accelerator properties payload | CustomizedAcceleratorProperties |
CustomizedAcceleratorProperties
| Name | Description | Value |
|---|---|---|
| acceleratorTags | string[] | |
| description | string | |
| displayName | string | |
| gitRepository | AcceleratorGitRepository (required) | |
| iconUrl | string |
AcceleratorGitRepository
| Name | Description | Value |
|---|---|---|
| authSetting | Properties of the auth setting payload. | AcceleratorAuthSetting (required) |
| branch | Git repository branch to be used. | string |
| commit | Git repository commit to be used. | string |
| gitTag | Git repository tag to be used. | string |
| intervalInSeconds | Interval for checking for updates to Git or image repository. | int |
| url | Git repository URL for the accelerator. | string (required) |
AcceleratorAuthSetting
| Name | Description | Value |
|---|---|---|
| authType | Set the object type | BasicAuth Public SSH (required) |
AcceleratorBasicAuthSetting
| Name | Description | Value |
|---|---|---|
| authType | The type of the auth setting. | "BasicAuth" (required) |
| password | Password of git repository basic auth. | string |
| username | Username of git repository basic auth. | string (required) |
AcceleratorPublicSetting
| Name | Description | Value |
|---|---|---|
| authType | The type of the auth setting. | "Public" (required) |
AcceleratorSshSetting
| Name | Description | Value |
|---|---|---|
| authType | The type of the auth setting. | "SSH" (required) |
| hostKey | Public SSH Key of git repository. | string |
| hostKeyAlgorithm | SSH Key algorithm of git repository. | string |
| privateKey | Private SSH Key algorithm of git repository. | string |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | Current capacity of the target resource | int |
| name | Name of the Sku | string |
| tier | Tier of the Sku | string |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for