Служба Microsoft.ApiManagement/workspaces/namedValues 2024-05-01
Определение ресурсов Bicep
Тип ресурса service/workspaces/namedValues можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/workspaces/namedValues, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/namedValues@2024-05-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
Значения свойств
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| identityClientId | Null для SystemAssignedIdentity или идентификатор клиента для UserAssignedIdentity, который будет использоваться для доступа к секрету хранилища ключей. | струна |
| secretIdentifier | Идентификатор секрета хранилища ключей для получения секрета. Предоставление секрета с версиями будет препятствовать автоматическому обновлению. Для этого требуется, чтобы служба управления API была настроена с помощью aka.ms/apimmsi | струна |
Microsoft.ApiManagement/service/workspaces/namedValues
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса | струна Ограничения целостности: Максимальная длина = 256 Pattern = ^[^*#&+:<>?]+$ (обязательно) |
| родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа: service/workspaces |
| свойства | Свойства контракта сущности NamedValue для операции PUT. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| displayName | Уникальное имя NamedValue. Он может содержать только буквы, цифры, точки, дефисы и символы подчеркивания. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 256 Pattern = ^[A-Za-z0-9-._]+$ (обязательно) |
| keyVault | Сведения о расположении KeyVault для именованного значения. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| секрет | Определяет, является ли значение секретом и должно быть зашифровано или нет. Значение по умолчанию — false. | bool |
| Теги | Необязательные теги, которые можно использовать для фильтрации списка NamedValue. | string[] |
| ценность | Значение Именованного значения. Может содержать выражения политики. Она может быть не пустой или состоять только из пробелов. Это свойство не будет заполнено в операциях GET! Используйте запрос POST "/listSecrets", чтобы получить это значение. | струна Ограничения целостности: Максимальная длина = 4096 |
Определение ресурса шаблона ARM
Тип ресурса service/workspaces/namedValues можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/workspaces/namedValues, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.ApiManagement/service/workspaces/namedValues",
"apiVersion": "2024-05-01",
"name": "string",
"properties": {
"displayName": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
Значения свойств
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| identityClientId | Null для SystemAssignedIdentity или идентификатор клиента для UserAssignedIdentity, который будет использоваться для доступа к секрету хранилища ключей. | струна |
| secretIdentifier | Идентификатор секрета хранилища ключей для получения секрета. Предоставление секрета с версиями будет препятствовать автоматическому обновлению. Для этого требуется, чтобы служба управления API была настроена с помощью aka.ms/apimmsi | струна |
Microsoft.ApiManagement/service/workspaces/namedValues
| Имя | Описание | Ценность |
|---|---|---|
| apiVersion | Версия API | '2024-05-01' |
| имя | Имя ресурса | струна Ограничения целостности: Максимальная длина = 256 Pattern = ^[^*#&+:<>?]+$ (обязательно) |
| свойства | Свойства контракта сущности NamedValue для операции PUT. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| тип | Тип ресурса | "Microsoft.ApiManagement/service/workspaces/namedValues" |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| displayName | Уникальное имя NamedValue. Он может содержать только буквы, цифры, точки, дефисы и символы подчеркивания. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 256 Pattern = ^[A-Za-z0-9-._]+$ (обязательно) |
| keyVault | Сведения о расположении KeyVault для именованного значения. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| секрет | Определяет, является ли значение секретом и должно быть зашифровано или нет. Значение по умолчанию — false. | bool |
| Теги | Необязательные теги, которые можно использовать для фильтрации списка NamedValue. | string[] |
| ценность | Значение Именованного значения. Может содержать выражения политики. Она может быть не пустой или состоять только из пробелов. Это свойство не будет заполнено в операциях GET! Используйте запрос POST "/listSecrets", чтобы получить это значение. | струна Ограничения целостности: Максимальная длина = 4096 |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса service/workspaces/namedValues можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/workspaces/namedValues, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/namedValues@2024-05-01"
name = "string"
body = jsonencode({
properties = {
displayName = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
secret = bool
tags = [
"string"
]
value = "string"
}
})
}
Значения свойств
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| identityClientId | Null для SystemAssignedIdentity или идентификатор клиента для UserAssignedIdentity, который будет использоваться для доступа к секрету хранилища ключей. | струна |
| secretIdentifier | Идентификатор секрета хранилища ключей для получения секрета. Предоставление секрета с версиями будет препятствовать автоматическому обновлению. Для этого требуется, чтобы служба управления API была настроена с помощью aka.ms/apimmsi | струна |
Microsoft.ApiManagement/service/workspaces/namedValues
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса | струна Ограничения целостности: Максимальная длина = 256 Pattern = ^[^*#&+:<>?]+$ (обязательно) |
| parent_id | Идентификатор ресурса, который является родительским для этого ресурса. | Идентификатор ресурса типа: service/workspaces |
| свойства | Свойства контракта сущности NamedValue для операции PUT. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| тип | Тип ресурса | "Microsoft.ApiManagement/service/workspaces/namedValues@2024-05-01" |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| displayName | Уникальное имя NamedValue. Он может содержать только буквы, цифры, точки, дефисы и символы подчеркивания. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 256 Pattern = ^[A-Za-z0-9-._]+$ (обязательно) |
| keyVault | Сведения о расположении KeyVault для именованного значения. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| секрет | Определяет, является ли значение секретом и должно быть зашифровано или нет. Значение по умолчанию — false. | bool |
| Теги | Необязательные теги, которые можно использовать для фильтрации списка NamedValue. | string[] |
| ценность | Значение Именованного значения. Может содержать выражения политики. Она может быть не пустой или состоять только из пробелов. Это свойство не будет заполнено в операциях GET! Используйте запрос POST "/listSecrets", чтобы получить это значение. | струна Ограничения целостности: Максимальная длина = 4096 |