Microsoft.AppPlatform Spring/certificates 2022-04-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@2022-04-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
type: 'string'
// For remaining properties, see CertificateProperties objects
}
}
CertificateProperties objects
Set the type property to specify the type of object.
For ContentCertificate, use:
type: 'ContentCertificate'
content: 'string'
For KeyVaultCertificate, use:
type: 'KeyVaultCertificate'
certVersion: 'string'
excludePrivateKey: bool
keyVaultCertName: 'string'
vaultUri: 'string'
Property values
Spring/certificates
Name | Description | Value |
---|---|---|
name | The resource name See how to set names and types for child resources in Bicep. |
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 the object type | ContentCertificate KeyVaultCertificate (required) |
ContentCertificateProperties
Name | Description | Value |
---|---|---|
type | The type of the certificate source. | 'ContentCertificate' (required) |
content | The content of uploaded certificate. | string |
KeyVaultCertificateProperties
Name | Description | Value |
---|---|---|
type | The type of the certificate source. | 'KeyVaultCertificate' (required) |
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) |
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.
Resource format
To create a Microsoft.AppPlatform/Spring/certificates resource, add the following JSON to your template.
{
"type": "Microsoft.AppPlatform/Spring/certificates",
"apiVersion": "2022-04-01",
"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:
"type": "ContentCertificate",
"content": "string"
For KeyVaultCertificate, use:
"type": "KeyVaultCertificate",
"certVersion": "string",
"excludePrivateKey": "bool",
"keyVaultCertName": "string",
"vaultUri": "string"
Property values
Spring/certificates
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.AppPlatform/Spring/certificates' |
apiVersion | The resource api version | '2022-04-01' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
properties | Properties of the certificate resource payload. | CertificateProperties |
CertificateProperties
Name | Description | Value |
---|---|---|
type | Set the object type | ContentCertificate KeyVaultCertificate (required) |
ContentCertificateProperties
Name | Description | Value |
---|---|---|
type | The type of the certificate source. | 'ContentCertificate' (required) |
content | The content of uploaded certificate. | string |
KeyVaultCertificateProperties
Name | Description | Value |
---|---|---|
type | The type of the certificate source. | 'KeyVaultCertificate' (required) |
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) |
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@2022-04-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
type = "string"
// For remaining properties, see CertificateProperties objects
}
})
}
CertificateProperties objects
Set the type property to specify the type of object.
For ContentCertificate, use:
type = "ContentCertificate"
content = "string"
For KeyVaultCertificate, use:
type = "KeyVaultCertificate"
certVersion = "string"
excludePrivateKey = bool
keyVaultCertName = "string"
vaultUri = "string"
Property values
Spring/certificates
Name | Description | Value |
---|---|---|
type | The resource type | "Microsoft.AppPlatform/Spring/certificates@2022-04-01" |
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 |
CertificateProperties
Name | Description | Value |
---|---|---|
type | Set the object type | ContentCertificate KeyVaultCertificate (required) |
ContentCertificateProperties
Name | Description | Value |
---|---|---|
type | The type of the certificate source. | "ContentCertificate" (required) |
content | The content of uploaded certificate. | string |
KeyVaultCertificateProperties
Name | Description | Value |
---|---|---|
type | The type of the certificate source. | "KeyVaultCertificate" (required) |
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) |
vaultUri | The vault uri of user key vault. | string (required) |
Feedback
https://aka.ms/ContentUserFeedback.
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:Submit and view feedback for