Служба и сертификаты Microsoft.ApiManagement
- последние
- 2023-09-01-preview
- 2022-08-01
- 2021-08-01
Определение ресурсов Bicep
Тип ресурса service/certificates можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/certificates, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.ApiManagement/service/certificates@2023-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
data: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
password: 'string'
}
}
Значения свойств
service/certificates
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса Узнайте, как задать имена и типы дочерних ресурсов в Bicep. |
строка (обязательно) Ограничение символов: 1–80 Допустимые символы: Буквенно-цифровые и дефисы. Начните с буквы и заканчивается буквенно-цифровым. |
| родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа: служба |
| свойства | Сведения о создании или обновлении свойств сертификата. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| Имя | Описание | Ценность |
|---|---|---|
| данные | Базовый 64 кодированный сертификат с помощью представления приложения или x-pkcs12. | струна |
| keyVault | Сведения о расположении keyVault для сертификата. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| пароль | Пароль для сертификата | струна |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Имя | Описание | Ценность |
|---|---|---|
| identityClientId | Null для SystemAssignedIdentity или идентификатор клиента для UserAssignedIdentity, который будет использоваться для доступа к секрету хранилища ключей. | струна |
| secretIdentifier | Идентификатор секрета хранилища ключей для получения секрета. Предоставление секрета с версиями будет препятствовать автоматическому обновлению. Для этого требуется, чтобы служба управления API была настроена с помощью aka.ms/apimmsi | струна |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
|
Создание экземпляра службы управления API и всех вложенных ресурсов с помощью шаблона развертывание  |
В этом шаблоне показано, как создать службу управления API и настроить вложенные сущности |
Определение ресурса шаблона ARM
Тип ресурса service/certificates можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/certificates, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.ApiManagement/service/certificates",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"data": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"password": "string"
}
}
Значения свойств
service/certificates
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип ресурса | "Microsoft.ApiManagement/service/certificates" |
| apiVersion | Версия API ресурсов | '2023-09-01-preview' |
| имя | Имя ресурса Узнайте, как задать имена и типы дочерних ресурсов в шаблонах ARM JSON. |
строка (обязательно) Ограничение символов: 1–80 Допустимые символы: Буквенно-цифровые и дефисы. Начните с буквы и заканчивается буквенно-цифровым. |
| свойства | Сведения о создании или обновлении свойств сертификата. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| Имя | Описание | Ценность |
|---|---|---|
| данные | Базовый 64 кодированный сертификат с помощью представления приложения или x-pkcs12. | струна |
| keyVault | Сведения о расположении keyVault для сертификата. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| пароль | Пароль для сертификата | струна |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Имя | Описание | Ценность |
|---|---|---|
| identityClientId | Null для SystemAssignedIdentity или идентификатор клиента для UserAssignedIdentity, который будет использоваться для доступа к секрету хранилища ключей. | струна |
| secretIdentifier | Идентификатор секрета хранилища ключей для получения секрета. Предоставление секрета с версиями будет препятствовать автоматическому обновлению. Для этого требуется, чтобы служба управления API была настроена с помощью aka.ms/apimmsi | струна |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
|
Создание экземпляра службы управления API и всех вложенных ресурсов с помощью шаблона развертывание |
В этом шаблоне показано, как создать службу управления API и настроить вложенные сущности |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса service/certificates можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/certificates, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/certificates@2023-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
data = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
password = "string"
}
})
}
Значения свойств
service/certificates
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип ресурса | "Microsoft.ApiManagement/service/certificates@2023-09-01-preview" |
| имя | Имя ресурса | строка (обязательно) Ограничение символов: 1–80 Допустимые символы: Буквенно-цифровые и дефисы. Начните с буквы и заканчивается буквенно-цифровым. |
| parent_id | Идентификатор ресурса, который является родительским для этого ресурса. | Идентификатор ресурса типа: службы |
| свойства | Сведения о создании или обновлении свойств сертификата. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| Имя | Описание | Ценность |
|---|---|---|
| данные | Базовый 64 кодированный сертификат с помощью представления приложения или x-pkcs12. | струна |
| keyVault | Сведения о расположении keyVault для сертификата. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| пароль | Пароль для сертификата | струна |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Имя | Описание | Ценность |
|---|---|---|
| identityClientId | Null для SystemAssignedIdentity или идентификатор клиента для UserAssignedIdentity, который будет использоваться для доступа к секрету хранилища ключей. | струна |
| secretIdentifier | Идентификатор секрета хранилища ключей для получения секрета. Предоставление секрета с версиями будет препятствовать автоматическому обновлению. Для этого требуется, чтобы служба управления API была настроена с помощью aka.ms/apimmsi | струна |