Поделиться через


Linker - Create Or Update

Создание или обновление ресурса компоновщика.

PUT https://management.azure.com/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}?api-version=2022-11-01-preview

Параметры URI

Имя В Обязательно Тип Описание
linkerName
path True

string

Имя ресурса компоновщика.

resourceUri
path True

string

Полный идентификатор Azure Resource Manager для подключаемого ресурса.

api-version
query True

string

Версия API, используемая для данной операции.

Текст запроса

Имя Тип Описание
properties.authInfo AuthInfoBase:

Тип проверки подлинности.

properties.clientType

clientType

Тип клиента приложения

properties.configurationInfo

ConfigurationInfo

Сведения о подключении, используемые приложениями, включая секреты, строки подключения.

properties.publicNetworkSolution

PublicNetworkSolution

Сетевое решение.

properties.scope

string

область подключения в исходной службе.

properties.secretStore

SecretStore

Возможность хранения значения секрета в безопасном месте

properties.targetService TargetServiceBase:

Свойства целевой службы

properties.vNetSolution

VNetSolution

Решение виртуальной сети.

Ответы

Имя Тип Описание
200 OK

LinkerResource

Успешной.

201 Created

LinkerResource

Длительная операция.

Other Status Codes

ErrorResponse

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

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"
    }
  }
}

Определения

Имя Описание
AccessKeyInfoBase

Ключ доступа непосредственно из свойств целевого ресурса, целевой службой которого является Ресурс Azure, например Microsoft.Storage.

accessKeyPermissions

Разрешения accessKey. Readи Write предназначены для Azure Cosmos DB и Конфигурация приложений Azure, Listenи Manage для Send концентратора событий Azure и Служебная шина Azure.

actionType

Необязательный элемент. Указывает решение общедоступной сети. Если этот параметр включен, включите доступ к общедоступной сети для целевой службы с лучшей попыткой. Значение по умолчанию — enable. Если отключить, откажитесь от конфигурации доступа к общедоступной сети.

allowType

Разрешите службам Azure доступ к целевой службе, если задано значение true.

AuthType

Тип проверки подлинности.

AzureKeyVaultProperties

Свойства ресурса, если тип — Azure Key Vault

AzureResource

Сведения о ресурсе Azure, если целевой тип службы — AzureResource

clientType

Тип клиента приложения

ConfigurationInfo

Сведения о конфигурации, используемые для создания конфигураций или сохранения в приложениях

ConfluentBootstrapServer

Свойства службы, если целевой тип службы — ConfluentBootstrapServer

ConfluentSchemaRegistry

Свойства службы, если целевой тип службы — ConfluentSchemaRegistry

createdByType

Тип удостоверения, создавшего ресурс.

DaprMetadata

Метаданные компонента dapr.

DaprProperties

Указывает некоторые дополнительные свойства для типа клиента dapr.

DeleteOrUpdateBehavior

Поведение очистки, указывающее, является ли операция очистки при удалении или обновлении ресурса

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Сообщение об ошибке

FirewallRules

Правила брандмауэра целевой службы. значение , чтобы разрешить подключения из исходной службы.

KeyVaultSecretReferenceSecretInfo

Сведения о секрете, если типом является keyVaultSecretReference. Для сценария пользователь предоставляет секрет, хранящийся в хранилище ключей пользователя, а источником является Azure Kubernetes. Идентификатор ресурса key Vault связан с secretStore.keyVaultId.

KeyVaultSecretUriSecretInfo

Сведения о секрете, если типом является keyVaultSecretUri. Для сценария пользователь предоставляет секрет, хранящийся в хранилище ключей пользователя, а источником является веб-приложение, Spring Cloud или контейнерное приложение.

LinkerResource

Компоновщик исходного и целевого ресурсов

PublicNetworkSolution

Указывает решение общедоступной сети, включить правила брандмауэра

SecretAuthInfo

Сведения о проверке подлинности, если authType является секретным

SecretStore

Возможность хранения значения секрета в безопасном месте

SecretType

Тип секрета.

SelfHostedServer

Свойства службы, если целевой тип службы — SelfHostedServer

ServicePrincipalCertificateAuthInfo

Сведения о проверке подлинности, если authType имеет значение servicePrincipal certificate

ServicePrincipalSecretAuthInfo

Сведения о проверке подлинности, если authType имеет секрет servicePrincipal

SystemAssignedIdentityAuthInfo

Сведения для проверки подлинности, если authType имеет значение systemAssignedIdentity

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

UserAccountAuthInfo

Сведения для проверки подлинности, если authType является учетной записью пользователя

UserAssignedIdentityAuthInfo

Сведения для проверки подлинности, если authType имеет значение userAssignedIdentity

ValueSecretInfo

Сведения о секрете, если типом является rawValue. Это для сценариев, в которые пользователь вводит секрет.

VNetSolution

Решение виртуальной сети для компоновщика

vNetSolutionType

Тип решения виртуальной сети.

AccessKeyInfoBase

Ключ доступа непосредственно из свойств целевого ресурса, целевой службой которого является Ресурс Azure, например Microsoft.Storage.

Имя Тип Описание
authType string:

accessKey

Тип проверки подлинности.

permissions

accessKeyPermissions[]

Разрешения accessKey. Readи Write предназначены для Azure Cosmos DB и Конфигурация приложений Azure, Listenи SendManage для Концентратора событий Azure и Служебная шина Azure.

accessKeyPermissions

Разрешения accessKey. Readи Write предназначены для Azure Cosmos DB и Конфигурация приложений Azure, Listenи Manage для Send концентратора событий Azure и Служебная шина Azure.

Имя Тип Описание
Listen

string

Manage

string

Read

string

Send

string

Write

string

actionType

Необязательный элемент. Указывает решение общедоступной сети. Если этот параметр включен, включите доступ к общедоступной сети для целевой службы с лучшей попыткой. Значение по умолчанию — enable. Если отключить, откажитесь от конфигурации доступа к общедоступной сети.

Имя Тип Описание
enable

string

optOut

string

allowType

Разрешите службам Azure доступ к целевой службе, если задано значение true.

Имя Тип Описание
false

string

true

string

AuthType

Тип проверки подлинности.

Имя Тип Описание
accessKey

string

secret

string

servicePrincipalCertificate

string

servicePrincipalSecret

string

systemAssignedIdentity

string

userAccount

string

userAssignedIdentity

string

AzureKeyVaultProperties

Свойства ресурса, если тип — Azure Key Vault

Имя Тип Описание
connectAsKubernetesCsiDriver

boolean

Значение true, если подключение осуществляется через драйвер CSI Kubernetes.

type string:

KeyVault

Тип ресурса Azure.

AzureResource

Сведения о ресурсе Azure, если целевой тип службы — AzureResource

Имя Тип Описание
id

string

Идентификатор ресурса Azure.

resourceProperties AzureResourcePropertiesBase:

AzureKeyVaultProperties

Свойства, связанные с подключением к ресурсу Azure.

type string:

AzureResource

Тип целевой службы.

clientType

Тип клиента приложения

Имя Тип Описание
dapr

string

django

string

dotnet

string

go

string

java

string

kafka-springBoot

string

nodejs

string

none

string

php

string

python

string

ruby

string

springBoot

string

ConfigurationInfo

Сведения о конфигурации, используемые для создания конфигураций или сохранения в приложениях

Имя Тип Описание
action

actionType

Необязательно. Укажите, следует ли применять конфигурации к исходному приложению. Если этот параметр включен, создайте конфигурации и примените к исходному приложению. Значение по умолчанию — enable. Если вы согласитесь, изменение конфигурации в источнике не будет выполнено.

additionalConfigurations

object

Словарь дополнительных конфигураций для добавления. Служба автоматически создаст набор базовых конфигураций, и это свойство предназначено для полного заполнения более настраиваемых конфигураций.

customizedKeys

object

Необязательный элемент. Словарь имен ключей по умолчанию и настраиваемого сопоставления имен ключей. Если значение не указано, для создания конфигураций будет использоваться имя ключа по умолчанию.

daprProperties

DaprProperties

Указывает некоторые дополнительные свойства для типа клиента dapr.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Указывает, следует ли очистить предыдущую операцию при обновлении или удалении компоновщика.

ConfluentBootstrapServer

Свойства службы, если целевой тип службы — ConfluentBootstrapServer

Имя Тип Описание
endpoint

string

Конечная точка службы.

type string:

ConfluentBootstrapServer

Тип целевой службы.

ConfluentSchemaRegistry

Свойства службы, если целевой тип службы — ConfluentSchemaRegistry

Имя Тип Описание
endpoint

string

Конечная точка службы.

type string:

ConfluentSchemaRegistry

Тип целевой службы.

createdByType

Тип удостоверения, создавшего ресурс.

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

DaprMetadata

Метаданные компонента dapr.

Имя Тип Описание
name

string

Имя свойства метаданных.

secretRef

string

Имя секрета, по которому dapr может получить значение

value

string

Значение свойства метаданных.

DaprProperties

Указывает некоторые дополнительные свойства для типа клиента dapr.

Имя Тип Описание
componentType

string

Тип компонента dapr

metadata

DaprMetadata[]

Дополнительные метаданные dapr

scopes

string[]

Области компонентов dapr

secretStoreComponent

string

Имя dapr хранилища секретов для получения секрета

version

string

Версия компонента dapr

DeleteOrUpdateBehavior

Поведение очистки, указывающее, является ли операция очистки при удалении или обновлении ресурса

Имя Тип Описание
Default

string

ForcedCleanup

string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorDetail[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
error

ErrorDetail

Объект error.

FirewallRules

Правила брандмауэра целевой службы. значение , чтобы разрешить подключения из исходной службы.

Имя Тип Описание
azureServices

allowType

Разрешите службам Azure доступ к целевой службе, если задано значение true.

callerClientIP

allowType

Разрешите IP-адресу клиента вызывающего объекта доступ к целевой службе, если задано значение true. свойство используется при подключении локального приложения к целевой службе.

ipRanges

string[]

Это значение указывает набор IP-адресов или диапазонов IP-адресов в форме CIDR, которые будут включены в список разрешенных IP-адресов клиента для данной учетной записи базы данных.

KeyVaultSecretReferenceSecretInfo

Сведения о секрете, если типом является keyVaultSecretReference. Для сценария пользователь предоставляет секрет, хранящийся в хранилище ключей пользователя, а источником является Azure Kubernetes. Идентификатор ресурса key Vault связан с secretStore.keyVaultId.

Имя Тип Описание
name

string

Имя секрета Key Vault.

secretType string:

keyVaultSecretReference

Тип секрета.

version

string

Версия секрета Key Vault.

KeyVaultSecretUriSecretInfo

Сведения о секрете, если типом является keyVaultSecretUri. Для сценария пользователь предоставляет секрет, хранящийся в хранилище ключей пользователя, а источником является веб-приложение, Spring Cloud или контейнерное приложение.

Имя Тип Описание
secretType string:

keyVaultSecretUri

Тип секрета.

value

string

URI для секрета хранилища ключей

LinkerResource

Компоновщик исходного и целевого ресурсов

Имя Тип Описание
id

string

Полный идентификатор ресурса. Например: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Имя ресурса.

properties.authInfo AuthInfoBase:

Тип проверки подлинности.

properties.clientType

clientType

Тип клиента приложения

properties.configurationInfo

ConfigurationInfo

Сведения о подключении, используемые приложениями, включая секреты, строки подключения.

properties.provisioningState

string

Состояние подготовки.

properties.publicNetworkSolution

PublicNetworkSolution

Сетевое решение.

properties.scope

string

область подключения в исходной службе.

properties.secretStore

SecretStore

Возможность хранения значения секрета в безопасном месте

properties.targetService TargetServiceBase:

Свойства целевой службы

properties.vNetSolution

VNetSolution

Решение виртуальной сети.

systemData

systemData

Системные данные.

type

string

Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

PublicNetworkSolution

Указывает решение общедоступной сети, включить правила брандмауэра

Имя Тип Описание
action

actionType

Необязательный элемент. Указывает решение общедоступной сети. Если этот параметр включен, лучше всего включить доступ к общедоступной сети целевой службы. Значение по умолчанию — enable. Если вы откажетесь, откажитесь от конфигурации доступа к общедоступной сети.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Указывает, следует ли очистить предыдущую операцию (например, правила брандмауэра) при обновлении или удалении компоновщика.

firewallRules

FirewallRules

Описать правила брандмауэра целевой службы, чтобы убедиться, что исходное приложение может подключиться к целевому объекту.

SecretAuthInfo

Сведения о проверке подлинности, если authType является секретным

Имя Тип Описание
authType string:

secret

Тип проверки подлинности.

name

string

Имя пользователя или имя учетной записи для секретной проверки подлинности.

secretInfo SecretInfoBase:

Пароль или секрет хранилища ключей для секретной проверки подлинности.

SecretStore

Возможность хранения значения секрета в безопасном месте

Имя Тип Описание
keyVaultId

string

Идентификатор хранилища ключей для хранения секрета

keyVaultSecretName

string

Имя секрета хранилища ключей для хранения секрета, допустимое только при хранении одного секрета

SecretType

Тип секрета.

Имя Тип Описание
keyVaultSecretReference

string

keyVaultSecretUri

string

rawValue

string

SelfHostedServer

Свойства службы, если целевой тип службы — SelfHostedServer

Имя Тип Описание
endpoint

string

Конечная точка службы.

type string:

SelfHostedServer

Тип целевой службы.

ServicePrincipalCertificateAuthInfo

Сведения о проверке подлинности, если authType имеет значение servicePrincipal certificate

Имя Тип Описание
authType string:

servicePrincipalCertificate

Тип проверки подлинности.

certificate

string

Сертификат ServicePrincipal для проверки подлинности servicePrincipal.

clientId

string

Application clientId для проверки подлинности servicePrincipal.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Указывает, следует ли очистить предыдущую операцию при обновлении или удалении компоновщика.

principalId

string

Идентификатор субъекта для проверки подлинности servicePrincipal.

roles

string[]

Необязательно. Это значение указывает роли Azure, которые необходимо назначить. Автоматически

ServicePrincipalSecretAuthInfo

Сведения о проверке подлинности, если authType имеет секрет servicePrincipal

Имя Тип Описание
authType string:

servicePrincipalSecret

Тип проверки подлинности.

clientId

string

ServicePrincipal application clientId для проверки подлинности servicePrincipal.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Указывает, следует ли очистить предыдущую операцию при обновлении или удалении компоновщика.

principalId

string

Идентификатор субъекта для проверки подлинности servicePrincipal.

roles

string[]

Необязательно. Это значение указывает роли Azure, которые необходимо назначить. Автоматически

secret

string

Секрет для проверки подлинности servicePrincipal.

userName

string

Имя пользователя, созданное в базе данных, которая сопоставляется с пользователем в AAD.

SystemAssignedIdentityAuthInfo

Сведения для проверки подлинности, если authType имеет значение systemAssignedIdentity

Имя Тип Описание
authType string:

systemAssignedIdentity

Тип проверки подлинности.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Указывает, следует ли очистить предыдущую операцию при обновлении или удалении компоновщика.

roles

string[]

Необязательно. Это значение указывает роль Azure для назначения.

userName

string

Имя пользователя, созданное в базе данных, которая сопоставляется с пользователем в AAD.

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя Тип Описание
createdAt

string

Метка времени создания ресурса (UTC).

createdBy

string

Удостоверение, создающее ресурс.

createdByType

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt

string

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy

string

Удостоверение, которое последним изменял ресурс.

lastModifiedByType

createdByType

Тип удостоверения, которое последним изменял ресурс.

UserAccountAuthInfo

Сведения для проверки подлинности, если authType является учетной записью пользователя

Имя Тип Описание
authType string:

userAccount

Тип проверки подлинности.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Указывает, следует ли очистить предыдущую операцию при обновлении или удалении компоновщика.

principalId

string

Идентификатор субъекта для учетной записи пользователя.

roles

string[]

Необязательно. Это значение указывает роли Azure, которые необходимо назначить. Автоматически

userName

string

Имя пользователя, созданное в базе данных, которая сопоставлена с пользователем в AAD.

UserAssignedIdentityAuthInfo

Сведения для проверки подлинности, если authType имеет значение userAssignedIdentity

Имя Тип Описание
authType string:

userAssignedIdentity

Тип проверки подлинности.

clientId

string

Идентификатор клиента для userAssignedIdentity.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Указывает, следует ли очистить предыдущую операцию при обновлении или удалении компоновщика.

roles

string[]

Необязательно. Это значение указывает роль Azure для назначения.

subscriptionId

string

Идентификатор подписки для userAssignedIdentity.

userName

string

Имя пользователя, созданное в базе данных, которая сопоставляется с пользователем в AAD.

ValueSecretInfo

Сведения о секрете, если типом является rawValue. Это для сценариев, в которые пользователь вводит секрет.

Имя Тип Описание
secretType string:

rawValue

Тип секрета.

value

string

Фактическое значение секрета.

VNetSolution

Решение виртуальной сети для компоновщика

Имя Тип Описание
deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Указывает, следует ли очистить предыдущую операцию при обновлении или удалении компоновщика.

type

vNetSolutionType

Тип решения виртуальной сети.

vNetSolutionType

Тип решения виртуальной сети.

Имя Тип Описание
privateLink

string

serviceEndpoint

string