Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
- Latest
- 2024-05-01-preview
- 2024-01-01-preview
- 2023-12-01
- 2023-11-01-preview
- 2023-09-01-preview
- 2023-07-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2023-01-01-preview
- 2022-12-01
- 2022-11-01-preview
- 2022-09-01-preview
- 2022-05-01-preview
- 2022-04-01
- 2022-03-01-preview
- 2022-01-01-preview
- 2021-09-01-preview
- 2021-06-01-preview
- 2020-11-01-preview
- 2020-07-01
Bicep resource definition
The Spring/certificates 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/certificates resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AppPlatform/Spring/certificates@2024-05-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
type: 'string'
// For remaining properties, see CertificateProperties objects
}
}
CertificateProperties objects
Set the type property to specify the type of object.
For ContentCertificate, use:
{
content: 'string'
type: 'ContentCertificate'
}
For KeyVaultCertificate, use:
{
autoSync: 'string'
certVersion: 'string'
excludePrivateKey: bool
keyVaultCertName: 'string'
type: 'KeyVaultCertificate'
vaultUri: 'string'
}
Property Values
Microsoft.AppPlatform/Spring/certificates
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| 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: Spring |
| properties | Properties of the certificate resource payload. | CertificateProperties |
CertificateProperties
| Name | Description | Value |
|---|---|---|
| type | Set to 'ContentCertificate' for type ContentCertificateProperties. Set to 'KeyVaultCertificate' for type KeyVaultCertificateProperties. | 'ContentCertificate' 'KeyVaultCertificate' (required) |
ContentCertificateProperties
| Name | Description | Value |
|---|---|---|
| content | The content of uploaded certificate. | string |
| type | The type of the certificate source. | 'ContentCertificate' (required) |
KeyVaultCertificateProperties
| Name | Description | Value |
|---|---|---|
| autoSync | Indicates whether to automatically synchronize certificate from key vault or not. | 'Disabled' 'Enabled' |
| certVersion | The certificate version of key vault. | string |
| excludePrivateKey | Optional. If set to true, it will not import private key from key vault. | bool |
| keyVaultCertName | The certificate name of key vault. | string (required) |
| type | The type of the certificate source. | 'KeyVaultCertificate' (required) |
| vaultUri | The vault uri of user key vault. | string (required) |
ARM template resource definition
The Spring/certificates 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.
Usage Examples
Resource format
To create a Microsoft.AppPlatform/Spring/certificates resource, add the following JSON to your template.
{
"type": "Microsoft.AppPlatform/Spring/certificates",
"apiVersion": "2024-05-01-preview",
"name": "string",
"properties": {
"type": "string"
// For remaining properties, see CertificateProperties objects
}
}
CertificateProperties objects
Set the type property to specify the type of object.
For ContentCertificate, use:
{
"content": "string",
"type": "ContentCertificate"
}
For KeyVaultCertificate, use:
{
"autoSync": "string",
"certVersion": "string",
"excludePrivateKey": "bool",
"keyVaultCertName": "string",
"type": "KeyVaultCertificate",
"vaultUri": "string"
}
Property Values
Microsoft.AppPlatform/Spring/certificates
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-05-01-preview' |
| name | The resource name | string (required) |
| properties | Properties of the certificate resource payload. | CertificateProperties |
| type | The resource type | 'Microsoft.AppPlatform/Spring/certificates' |
CertificateProperties
| Name | Description | Value |
|---|---|---|
| type | Set to 'ContentCertificate' for type ContentCertificateProperties. Set to 'KeyVaultCertificate' for type KeyVaultCertificateProperties. | 'ContentCertificate' 'KeyVaultCertificate' (required) |
ContentCertificateProperties
| Name | Description | Value |
|---|---|---|
| content | The content of uploaded certificate. | string |
| type | The type of the certificate source. | 'ContentCertificate' (required) |
KeyVaultCertificateProperties
| Name | Description | Value |
|---|---|---|
| autoSync | Indicates whether to automatically synchronize certificate from key vault or not. | 'Disabled' 'Enabled' |
| certVersion | The certificate version of key vault. | string |
| excludePrivateKey | Optional. If set to true, it will not import private key from key vault. | bool |
| keyVaultCertName | The certificate name of key vault. | string (required) |
| type | The type of the certificate source. | 'KeyVaultCertificate' (required) |
| vaultUri | The vault uri of user key vault. | string (required) |
Terraform (AzAPI provider) resource definition
The Spring/certificates 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/certificates resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AppPlatform/Spring/certificates@2024-05-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
type = "string"
// For remaining properties, see CertificateProperties objects
}
}
}
CertificateProperties objects
Set the type property to specify the type of object.
For ContentCertificate, use:
{
content = "string"
type = "ContentCertificate"
}
For KeyVaultCertificate, use:
{
autoSync = "string"
certVersion = "string"
excludePrivateKey = bool
keyVaultCertName = "string"
type = "KeyVaultCertificate"
vaultUri = "string"
}
Property Values
Microsoft.AppPlatform/Spring/certificates
| Name | Description | Value |
|---|---|---|
| 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: Spring |
| properties | Properties of the certificate resource payload. | CertificateProperties |
| type | The resource type | "Microsoft.AppPlatform/Spring/certificates@2024-05-01-preview" |
CertificateProperties
| Name | Description | Value |
|---|---|---|
| type | Set to 'ContentCertificate' for type ContentCertificateProperties. Set to 'KeyVaultCertificate' for type KeyVaultCertificateProperties. | 'ContentCertificate' 'KeyVaultCertificate' (required) |
ContentCertificateProperties
| Name | Description | Value |
|---|---|---|
| content | The content of uploaded certificate. | string |
| type | The type of the certificate source. | 'ContentCertificate' (required) |
KeyVaultCertificateProperties
| Name | Description | Value |
|---|---|---|
| autoSync | Indicates whether to automatically synchronize certificate from key vault or not. | 'Disabled' 'Enabled' |
| certVersion | The certificate version of key vault. | string |
| excludePrivateKey | Optional. If set to true, it will not import private key from key vault. | bool |
| keyVaultCertName | The certificate name of key vault. | string (required) |
| type | The type of the certificate source. | 'KeyVaultCertificate' (required) |
| vaultUri | The vault uri of user key vault. | string (required) |