Linker - Create Or Update
Создание или обновление ресурса компоновщика.
PUT https://management.azure.com/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}?api-version=2022-11-01-preview
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
linker
|
path | True |
string |
Ресурс компоновщика имен. |
|
resource
|
path | True |
string |
Полный идентификатор Azure Resource Manager для подключения к ресурсу. |
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для этой операции. |
Текст запроса
| Имя | Тип | Описание |
|---|---|---|
| properties.authInfo | AuthInfoBase: |
Тип проверки подлинности. |
| properties.clientType |
Тип клиента приложения |
|
| properties.configurationInfo |
Сведения о подключении, потребляемые приложениями, включая секреты, строки подключения. |
|
| properties.publicNetworkSolution |
Сетевое решение. |
|
| properties.scope |
string |
область подключения в исходной службе. |
| properties.secretStore |
Возможность хранения значения секрета в безопасном месте |
|
| properties.targetService | TargetServiceBase: |
Свойства целевой службы |
| properties.vNetSolution |
Решение виртуальной сети. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Успешный. |
|
| 201 Created |
Длительная операция. |
|
| Other Status Codes |
Ответ на ошибку, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 Azure Active Directory.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| user_impersonation | олицетворения учетной записи пользователя |
Примеры
PutLinker
Образец запроса
PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/linkers/linkName?api-version=2022-11-01-preview
{
"properties": {
"targetService": {
"type": "AzureResource",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db"
},
"vNetSolution": {
"type": "serviceEndpoint"
},
"authInfo": {
"authType": "secret",
"name": "name",
"secretInfo": {
"secretType": "rawValue",
"value": "secret"
}
}
}
}
Пример ответа
{
"type": "Microsoft.ServiceLinker/links",
"name": "linkName",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName",
"properties": {
"authInfo": {
"authType": "secret",
"name": "name"
},
"vNetSolution": {
"type": "serviceEndpoint"
},
"targetService": {
"type": "AzureResource",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db"
}
}
}
{
"type": "Microsoft.ServiceLinker/links",
"name": "linkName",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName",
"properties": {
"authInfo": {
"authType": "secret",
"name": "name"
},
"vNetSolution": {
"type": "serviceEndpoint"
},
"targetService": {
"type": "AzureResource",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db"
}
}
}
Определения
| Имя | Описание |
|---|---|
|
Access |
Ключ доступа непосредственно из свойств целевого ресурса, который является целевой службой Azure Resource, например Microsoft.Storage |
|
access |
Разрешения accessKey.
|
|
action |
Необязательно. Указывает решение общедоступной сети. Если этот параметр включен, включите доступ к общедоступной сети целевой службы с лучшим способом. По умолчанию включена. Если вы решите отказаться, откажитесь от конфигурации доступа к общедоступной сети. |
|
allow |
Разрешить службам Azure доступ к целевой службе, если это верно. |
|
Auth |
Тип проверки подлинности. |
|
Azure |
Свойства ресурса при типе Azure Key Vault |
|
Azure |
Сведения о ресурсе Azure, если тип целевой службы — AzureResource |
|
client |
Тип клиента приложения |
|
Configuration |
Сведения о конфигурации, используемые для создания конфигураций или сохранения в приложениях |
|
Confluent |
Свойства службы, когда тип целевой службы — ConfluentBootstrapServer |
|
Confluent |
Свойства службы, когда тип целевой службы — ConfluentSchemaRegistry |
|
created |
Тип удостоверения, создавшего ресурс. |
|
Dapr |
Метаданные компонента dapr. |
|
Dapr |
Указывает некоторые дополнительные свойства для типа клиента dapr |
|
Delete |
Поведение очистки, указывающее, выполняется ли операция очистки при удалении или обновлении ресурса |
|
Error |
Дополнительные сведения об ошибке управления ресурсами. |
|
Error |
Сведения об ошибке. |
|
Error |
Ответ на ошибку |
|
Firewall |
Правила брандмауэра целевой службы. разрешение подключений из исходной службы. |
|
Key |
Сведения о секрете при типе keyVaultSecretReference. В этом случае пользователь предоставляет секрет, хранящийся в ключе пользователя и источнике, — Azure Kubernetes. Идентификатор ресурса хранилища ключей связан с secretStore.keyVaultId. |
|
Key |
Сведения о секрете при типе keyVaultSecretUri. Это для сценария, когда пользователь предоставляет секрет, хранящийся в ключе пользователя, и источник — web App, Spring Cloud или контейнерное приложение. |
|
Linker |
Компоновщик исходного и целевого ресурса |
|
Public |
Указывает общедоступное сетевое решение, включайте правила брандмауэра |
|
Secret |
Сведения о проверке подлинности при секрете authType |
|
Secret |
Возможность хранения значения секрета в безопасном месте |
|
Secret |
Тип секрета. |
|
Self |
Свойства службы, когда тип целевой службы — SelfHostedServer |
|
Service |
Сведения о проверке подлинности, если authType — сертификат servicePrincipal |
|
Service |
Сведения о проверке подлинности, если authType — секрет servicePrincipal |
|
System |
Сведения о проверке подлинности, если authType — systemAssignedIdentity |
|
system |
Метаданные, относящиеся к созданию и последнему изменении ресурса. |
|
User |
Сведения о проверке подлинности, если authType является учетной записью пользователя |
|
User |
Сведения о проверке подлинности, если authType — userAssignedIdentity |
|
Value |
Сведения о секрете при вводе необработанного значения. Это для сценариев, которые пользователь вводит секрет. |
|
VNet |
Решение виртуальной сети для компоновщика |
|
v |
Тип решения виртуальной сети. |
AccessKeyInfoBase
Ключ доступа непосредственно из свойств целевого ресурса, который является целевой службой Azure Resource, например Microsoft.Storage
| Имя | Тип | Описание |
|---|---|---|
| authType |
string:
access |
Тип проверки подлинности. |
| permissions |
Разрешения accessKey.
|
accessKeyPermissions
Разрешения accessKey.
Read и Write предназначены для Azure Cosmos DB и конфигурации приложений Azure, Listen, Send и Manage предназначены для Концентратора событий Azure и служебной шины Azure.
| Значение | Описание |
|---|---|
| Read | |
| Write | |
| Listen | |
| Send | |
| Manage |
actionType
Необязательно. Указывает решение общедоступной сети. Если этот параметр включен, включите доступ к общедоступной сети целевой службы с лучшим способом. По умолчанию включена. Если вы решите отказаться, откажитесь от конфигурации доступа к общедоступной сети.
| Значение | Описание |
|---|---|
| enable | |
| optOut |
allowType
Разрешить службам Azure доступ к целевой службе, если это верно.
| Значение | Описание |
|---|---|
| true | |
| false |
AuthType
Тип проверки подлинности.
| Значение | Описание |
|---|---|
| systemAssignedIdentity | |
| userAssignedIdentity | |
| servicePrincipalSecret | |
| servicePrincipalCertificate | |
| secret | |
| accessKey | |
| userAccount |
AzureKeyVaultProperties
Свойства ресурса при типе Azure Key Vault
| Имя | Тип | Описание |
|---|---|---|
| connectAsKubernetesCsiDriver |
boolean |
Значение True, если подключение через драйвер CSI Kubernetes. |
| type |
string:
Key |
Тип ресурса Azure. |
AzureResource
Сведения о ресурсе Azure, если тип целевой службы — AzureResource
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Идентификатор ресурса Azure. |
| resourceProperties | AzureResourcePropertiesBase: |
Связанные свойства подключения к ресурсам Azure. |
| type | string: |
Тип целевой службы. |
clientType
Тип клиента приложения
| Значение | Описание |
|---|---|
| none | |
| dotnet | |
| java | |
| python | |
| go | |
| php | |
| ruby | |
| django | |
| nodejs | |
| springBoot | |
| kafka-springBoot | |
| dapr |
ConfigurationInfo
Сведения о конфигурации, используемые для создания конфигураций или сохранения в приложениях
| Имя | Тип | Описание |
|---|---|---|
| action |
Необязательно, укажите, следует ли применять конфигурации к исходному приложению. Если включить, создайте конфигурации и применяется к исходному приложению. По умолчанию включена. Если вы решите, изменение конфигурации не будет сделано в источнике. |
|
| additionalConfigurations |
object |
Словарь дополнительных конфигураций для добавления. Служба автоматически создаст набор базовых конфигураций, и это свойство будет полностью заполнено более настраиваемыми конфигурациями. |
| customizedKeys |
object |
Необязательно. Словарь имени ключа по умолчанию и настраиваемого сопоставления имен ключей. Если не указано, для создания конфигураций будет использоваться имя ключа по умолчанию. |
| daprProperties |
Указывает некоторые дополнительные свойства для типа клиента dapr |
|
| deleteOrUpdateBehavior |
Указывает, следует ли очистить предыдущую операцию при обновлении или удалении компоновщика |
ConfluentBootstrapServer
Свойства службы, когда тип целевой службы — ConfluentBootstrapServer
| Имя | Тип | Описание |
|---|---|---|
| endpoint |
string |
Конечная точка службы. |
| type | string: |
Тип целевой службы. |
ConfluentSchemaRegistry
Свойства службы, когда тип целевой службы — ConfluentSchemaRegistry
| Имя | Тип | Описание |
|---|---|---|
| endpoint |
string |
Конечная точка службы. |
| type | string: |
Тип целевой службы. |
createdByType
Тип удостоверения, создавшего ресурс.
| Значение | Описание |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DaprMetadata
Метаданные компонента dapr.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Имя свойства метаданных. |
| secretRef |
string |
Имя секрета, в котором dapr может получить значение |
| value |
string |
Значение свойства метаданных. |
DaprProperties
Указывает некоторые дополнительные свойства для типа клиента dapr
| Имя | Тип | Описание |
|---|---|---|
| componentType |
string |
Тип компонента dapr |
| metadata |
Дополнительные метаданные dapr |
|
| scopes |
string[] |
Области компонентов dapr |
| secretStoreComponent |
string |
Имя dapr хранилища секретов для получения секрета |
| version |
string |
Версия компонента dapr |
DeleteOrUpdateBehavior
Поведение очистки, указывающее, выполняется ли операция очистки при удалении или обновлении ресурса
| Значение | Описание |
|---|---|
| Default | |
| ForcedCleanup |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
| Имя | Тип | Описание |
|---|---|---|
| info |
object |
Дополнительные сведения. |
| type |
string |
Дополнительный тип сведений. |
ErrorDetail
Сведения об ошибке.
| Имя | Тип | Описание |
|---|---|---|
| additionalInfo |
Дополнительные сведения об ошибке. |
|
| code |
string |
Код ошибки. |
| details |
Сведения об ошибке. |
|
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект ошибки. |
ErrorResponse
Ответ на ошибку
| Имя | Тип | Описание |
|---|---|---|
| error |
Объект ошибки. |
FirewallRules
Правила брандмауэра целевой службы. разрешение подключений из исходной службы.
| Имя | Тип | Описание |
|---|---|---|
| azureServices |
Разрешить службам Azure доступ к целевой службе, если это верно. |
|
| callerClientIP |
Разрешите IP-адресу клиента вызывающего абонента получить доступ к целевой службе, если значение true. свойство используется при подключении локального приложения к целевой службе. |
|
| ipRanges |
string[] |
Это значение указывает набор IP-адресов или диапазонов IP-адресов в форме CIDR, которые будут включены в список разрешенных IP-адресов клиента для данной учетной записи базы данных. |
KeyVaultSecretReferenceSecretInfo
Сведения о секрете при типе keyVaultSecretReference. В этом случае пользователь предоставляет секрет, хранящийся в ключе пользователя и источнике, — Azure Kubernetes. Идентификатор ресурса хранилища ключей связан с secretStore.keyVaultId.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Имя секрета Key Vault. |
| secretType |
string:
key |
Тип секрета. |
| version |
string |
Версия секрета Key Vault. |
KeyVaultSecretUriSecretInfo
Сведения о секрете при типе keyVaultSecretUri. Это для сценария, когда пользователь предоставляет секрет, хранящийся в ключе пользователя, и источник — web App, Spring Cloud или контейнерное приложение.
| Имя | Тип | Описание |
|---|---|---|
| secretType |
string:
key |
Тип секрета. |
| value |
string |
Универсальный код ресурса (URI) для секрета keyvault |
LinkerResource
Компоновщик исходного и целевого ресурса
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| name |
string |
Имя ресурса |
| properties.authInfo | AuthInfoBase: |
Тип проверки подлинности. |
| properties.clientType |
Тип клиента приложения |
|
| properties.configurationInfo |
Сведения о подключении, потребляемые приложениями, включая секреты, строки подключения. |
|
| properties.provisioningState |
string |
Состояние подготовки. |
| properties.publicNetworkSolution |
Сетевое решение. |
|
| properties.scope |
string |
область подключения в исходной службе. |
| properties.secretStore |
Возможность хранения значения секрета в безопасном месте |
|
| properties.targetService | TargetServiceBase: |
Свойства целевой службы |
| properties.vNetSolution |
Решение виртуальной сети. |
|
| systemData |
Системные данные. |
|
| type |
string |
Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" |
PublicNetworkSolution
Указывает общедоступное сетевое решение, включайте правила брандмауэра
| Имя | Тип | Описание |
|---|---|---|
| action |
Необязательно. Указывает решение общедоступной сети. Если этот параметр включен, включите доступ к общедоступной сети целевой службы с лучшим способом. По умолчанию включена. Если вы решите отказаться, откажитесь от конфигурации доступа к общедоступной сети. |
|
| deleteOrUpdateBehavior |
Указывает, следует ли очистить предыдущую операцию (например, правила брандмауэра) при обновлении или удалении компоновщика. |
|
| firewallRules |
Описать правила брандмауэра целевой службы, чтобы убедиться, что исходное приложение может подключиться к целевому объекту. |
SecretAuthInfo
Сведения о проверке подлинности при секрете authType
| Имя | Тип | Описание |
|---|---|---|
| authType |
string:
secret |
Тип проверки подлинности. |
| name |
string |
Имя пользователя или имя учетной записи для секретной проверки подлинности. |
| secretInfo | SecretInfoBase: |
Секрет пароля или хранилища ключей для проверки подлинности секрета. |
SecretStore
Возможность хранения значения секрета в безопасном месте
| Имя | Тип | Описание |
|---|---|---|
| keyVaultId |
string |
Идентификатор хранилища ключей для хранения секрета |
| keyVaultSecretName |
string |
Имя секрета хранилища ключей для хранения секрета допустимо только при сохранении одного секрета |
SecretType
Тип секрета.
| Значение | Описание |
|---|---|
| rawValue | |
| keyVaultSecretUri | |
| keyVaultSecretReference |
SelfHostedServer
Свойства службы, когда тип целевой службы — SelfHostedServer
| Имя | Тип | Описание |
|---|---|---|
| endpoint |
string |
Конечная точка службы. |
| type | string: |
Тип целевой службы. |
ServicePrincipalCertificateAuthInfo
Сведения о проверке подлинности, если authType — сертификат servicePrincipal
| Имя | Тип | Описание |
|---|---|---|
| authType |
string:
service |
Тип проверки подлинности. |
| certificate |
string |
Сертификат ServicePrincipal для проверки подлинности servicePrincipal. |
| clientId |
string |
Идентификатор клиента приложения для проверки подлинности servicePrincipal. |
| deleteOrUpdateBehavior |
Указывает, следует ли очистить предыдущую операцию при обновлении или удалении компоновщика |
|
| principalId |
string |
Идентификатор субъекта для проверки подлинности servicePrincipal. |
| roles |
string[] |
Необязательно, это значение указывает назначенные роли Azure. Автоматически |
ServicePrincipalSecretAuthInfo
Сведения о проверке подлинности, если authType — секрет servicePrincipal
| Имя | Тип | Описание |
|---|---|---|
| authType |
string:
service |
Тип проверки подлинности. |
| clientId |
string |
Идентификатор клиента приложения ServicePrincipal для проверки подлинности servicePrincipal. |
| deleteOrUpdateBehavior |
Указывает, следует ли очистить предыдущую операцию при обновлении или удалении компоновщика |
|
| principalId |
string |
Идентификатор субъекта для проверки подлинности servicePrincipal. |
| roles |
string[] |
Необязательно, это значение указывает назначенные роли Azure. Автоматически |
| secret |
string |
Секрет для проверки подлинности servicePrincipal. |
| userName |
string |
Имя пользователя, созданное в базе данных, сопоставленной с пользователем в AAD. |
SystemAssignedIdentityAuthInfo
Сведения о проверке подлинности, если authType — systemAssignedIdentity
| Имя | Тип | Описание |
|---|---|---|
| authType |
string:
system |
Тип проверки подлинности. |
| deleteOrUpdateBehavior |
Указывает, следует ли очистить предыдущую операцию при обновлении или удалении компоновщика |
|
| roles |
string[] |
Необязательно, это значение указывает роль Azure, назначаемую |
| userName |
string |
Имя пользователя, созданное в базе данных, сопоставленной с пользователем в AAD. |
systemData
Метаданные, относящиеся к созданию и последнему изменении ресурса.
| Имя | Тип | Описание |
|---|---|---|
| createdAt |
string (date-time) |
Метка времени создания ресурса (UTC). |
| createdBy |
string |
Удостоверение, создающее ресурс. |
| createdByType |
Тип удостоверения, создавшего ресурс. |
|
| lastModifiedAt |
string (date-time) |
Метка времени последнего изменения ресурса (UTC) |
| lastModifiedBy |
string |
Идентификатор, который последний раз изменил ресурс. |
| lastModifiedByType |
Тип удостоверения, который последний раз изменил ресурс. |
UserAccountAuthInfo
Сведения о проверке подлинности, если authType является учетной записью пользователя
| Имя | Тип | Описание |
|---|---|---|
| authType |
string:
user |
Тип проверки подлинности. |
| deleteOrUpdateBehavior |
Указывает, следует ли очистить предыдущую операцию при обновлении или удалении компоновщика |
|
| principalId |
string |
Идентификатор субъекта для учетной записи пользователя. |
| roles |
string[] |
Необязательно, это значение указывает назначенные роли Azure. Автоматически |
| userName |
string |
Имя пользователя, созданное в базе данных, сопоставленной с пользователем в AAD. |
UserAssignedIdentityAuthInfo
Сведения о проверке подлинности, если authType — userAssignedIdentity
| Имя | Тип | Описание |
|---|---|---|
| authType |
string:
user |
Тип проверки подлинности. |
| clientId |
string |
Идентификатор клиента для userAssignedIdentity. |
| deleteOrUpdateBehavior |
Указывает, следует ли очистить предыдущую операцию при обновлении или удалении компоновщика |
|
| roles |
string[] |
Необязательно, это значение указывает роль Azure, назначаемую |
| subscriptionId |
string |
Идентификатор подписки для userAssignedIdentity. |
| userName |
string |
Имя пользователя, созданное в базе данных, сопоставленной с пользователем в AAD. |
ValueSecretInfo
Сведения о секрете при вводе необработанного значения. Это для сценариев, которые пользователь вводит секрет.
| Имя | Тип | Описание |
|---|---|---|
| secretType |
string:
raw |
Тип секрета. |
| value |
string |
Фактическое значение секрета. |
VNetSolution
Решение виртуальной сети для компоновщика
| Имя | Тип | Описание |
|---|---|---|
| deleteOrUpdateBehavior |
Указывает, следует ли очистить предыдущую операцию при обновлении или удалении компоновщика |
|
| type |
Тип решения виртуальной сети. |
vNetSolutionType
Тип решения виртуальной сети.
| Значение | Описание |
|---|---|
| serviceEndpoint | |
| privateLink |