Linker - Create Or Update
Cree o actualice el recurso del enlazador.
PUT https://management.azure.com/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}?api-version=2022-11-01-preview
Parámetros de identificador URI
| Nombre | En | Requerido | Tipo | Description |
|---|---|---|---|---|
|
linker
|
path | True |
string |
El recurso del enlazador de nombres. |
|
resource
|
path | True |
string |
Identificador completo de Azure Resource Manager del recurso que se va a conectar. |
|
api-version
|
query | True |
string minLength: 1 |
Versión de la API que se va a usar para esta operación. |
Cuerpo de la solicitud
| Nombre | Tipo | Description |
|---|---|---|
| properties.authInfo | AuthInfoBase: |
Tipo de autenticación. |
| properties.clientType |
Tipo de cliente de aplicación |
|
| properties.configurationInfo |
La información de conexión consumida por las aplicaciones, incluidos los secretos, las cadenas de conexión. |
|
| properties.publicNetworkSolution |
Solución de red. |
|
| properties.scope |
string |
ámbito de conexión en el servicio de origen. |
| properties.secretStore |
Una opción para almacenar el valor secreto en un lugar seguro |
|
| properties.targetService | TargetServiceBase: |
Propiedades del servicio de destino |
| properties.vNetSolution |
La solución de red virtual. |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK |
Exitoso. |
|
| 201 Created |
Operación de larga duración. |
|
| Other Status Codes |
Respuesta de error que describe por qué se produjo un error en la operación. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
| Nombre | Description |
|---|---|
| user_impersonation | suplantar la cuenta de usuario |
Ejemplos
PutLinker
Solicitud de ejemplo
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"
}
}
}
}
Respuesta de muestra
{
"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"
}
}
}
Definiciones
| Nombre | Description |
|---|---|
|
Access |
La clave de acceso directamente desde las propiedades de recursos de destino, que el servicio de destino es Recurso de Azure, como Microsoft.Storage. |
|
access |
Permisos de accessKey.
|
|
action |
Opcional. Indica la solución de red pública. Si está habilitado, habilite el acceso a la red pública del servicio de destino con el mejor intento. El valor predeterminado es habilitar. Si opta por no participar, opte por la configuración de acceso a la red pública. |
|
allow |
Permitir que los servicios de Azure accedan al servicio de destino si es true. |
|
Auth |
Tipo de autenticación. |
|
Azure |
Propiedades de recurso cuando el tipo es Azure Key Vault |
|
Azure |
La información del recurso de Azure cuando el tipo de servicio de destino es AzureResource |
|
client |
Tipo de cliente de aplicación |
|
Configuration |
La información de configuración, que se usa para generar configuraciones o guardar en aplicaciones |
|
Confluent |
Las propiedades del servicio cuando el tipo de servicio de destino es ConfluentBootstrapServer |
|
Confluent |
Las propiedades del servicio cuando el tipo de servicio de destino es ConfluentSchemaRegistry |
|
created |
Tipo de identidad que creó el recurso. |
|
Dapr |
Metadatos del componente dapr. |
|
Dapr |
Indica algunas propiedades adicionales para el tipo de cliente dapr. |
|
Delete |
Comportamiento de limpieza para indicar si la operación de limpieza se elimina o actualiza el recurso. |
|
Error |
Información adicional sobre el error de administración de recursos. |
|
Error |
Detalle del error. |
|
Error |
Respuesta de error |
|
Firewall |
Reglas de firewall del servicio de destino. para permitir conexiones desde el servicio de origen. |
|
Key |
Información secreta cuando el tipo es keyVaultSecretReference. Es para el escenario en el que el usuario proporciona un secreto almacenado en el almacén de claves del usuario y el origen es Azure Kubernetes. El identificador de recurso de Key Vault está vinculado a secretStore.keyVaultId. |
|
Key |
Información secreta cuando el tipo es keyVaultSecretUri. Es para escenarios en los que el usuario proporciona un secreto almacenado en el almacén de claves del usuario y el origen es Web App, Spring Cloud o Container App. |
|
Linker |
Enlazador del recurso de origen y destino |
|
Public |
Indica la solución de red pública, incluir reglas de firewall. |
|
Secret |
La información de autenticación cuando authType es secreto |
|
Secret |
Una opción para almacenar el valor secreto en un lugar seguro |
|
Secret |
Tipo de secreto. |
|
Self |
Las propiedades del servicio cuando el tipo de servicio de destino es SelfHostedServer |
|
Service |
La información de autenticación cuando authType es el certificado servicePrincipal |
|
Service |
La información de autenticación cuando authType es servicePrincipal secret |
|
System |
La información de autenticación cuando authType es systemAssignedIdentity |
|
system |
Metadatos relativos a la creación y última modificación del recurso. |
|
User |
La información de autenticación cuando authType es una cuenta de usuario |
|
User |
La información de autenticación cuando authType es userAssignedIdentity |
|
Value |
Información secreta cuando el tipo es rawValue. Es para escenarios en los que el usuario escribe el secreto. |
|
VNet |
Solución de red virtual para enlazador |
|
v |
Tipo de solución de red virtual. |
AccessKeyInfoBase
La clave de acceso directamente desde las propiedades de recursos de destino, que el servicio de destino es Recurso de Azure, como Microsoft.Storage.
| Nombre | Tipo | Description |
|---|---|---|
| authType |
string:
access |
Tipo de autenticación. |
| permissions |
Permisos de accessKey.
|
accessKeyPermissions
Permisos de accessKey.
Read y Write son para Azure Cosmos DB y Azure App Configuration, Listen, Send y Manage son para Azure Event Hub y Azure Service Bus.
| Valor | Description |
|---|---|
| Read | |
| Write | |
| Listen | |
| Send | |
| Manage |
actionType
Opcional. Indica la solución de red pública. Si está habilitado, habilite el acceso a la red pública del servicio de destino con el mejor intento. El valor predeterminado es habilitar. Si opta por no participar, opte por la configuración de acceso a la red pública.
| Valor | Description |
|---|---|
| enable | |
| optOut |
allowType
Permitir que los servicios de Azure accedan al servicio de destino si es true.
| Valor | Description |
|---|---|
| true | |
| false |
AuthType
Tipo de autenticación.
| Valor | Description |
|---|---|
| systemAssignedIdentity | |
| userAssignedIdentity | |
| servicePrincipalSecret | |
| servicePrincipalCertificate | |
| secret | |
| accessKey | |
| userAccount |
AzureKeyVaultProperties
Propiedades de recurso cuando el tipo es Azure Key Vault
| Nombre | Tipo | Description |
|---|---|---|
| connectAsKubernetesCsiDriver |
boolean |
True si se conecta a través del controlador CSI de Kubernetes. |
| type |
string:
Key |
Tipo de recurso de Azure. |
AzureResource
La información del recurso de Azure cuando el tipo de servicio de destino es AzureResource
| Nombre | Tipo | Description |
|---|---|---|
| id |
string |
Identificador del recurso de Azure. |
| resourceProperties | AzureResourcePropertiesBase: |
Propiedades relacionadas con la conexión de recursos de Azure. |
| type | string: |
Tipo de servicio de destino. |
clientType
Tipo de cliente de aplicación
| Valor | Description |
|---|---|
| none | |
| dotnet | |
| java | |
| python | |
| go | |
| php | |
| ruby | |
| django | |
| nodejs | |
| springBoot | |
| kafka-springBoot | |
| dapr |
ConfigurationInfo
La información de configuración, que se usa para generar configuraciones o guardar en aplicaciones
| Nombre | Tipo | Description |
|---|---|---|
| action |
Opcional, indique si se deben aplicar configuraciones en la aplicación de origen. Si se habilita, genere configuraciones y se aplique a la aplicación de origen. El valor predeterminado es habilitar. Si optOut, no se realizará ningún cambio de configuración en el origen. |
|
| additionalConfigurations |
object |
Diccionario de configuraciones adicionales que se van a agregar. El servicio generará automáticamente un conjunto de configuraciones básicas y esta propiedad se rellenará con más configuraciones personalizadas. |
| customizedKeys |
object |
Opcional. Diccionario de nombre de clave predeterminado y asignación personalizada de nombres de clave. Si no se especifica, se usará el nombre de clave predeterminado para generar configuraciones. |
| daprProperties |
Indica algunas propiedades adicionales para el tipo de cliente dapr. |
|
| deleteOrUpdateBehavior |
Indica si se va a limpiar la operación anterior cuando Linker está actualizando o eliminando. |
ConfluentBootstrapServer
Las propiedades del servicio cuando el tipo de servicio de destino es ConfluentBootstrapServer
| Nombre | Tipo | Description |
|---|---|---|
| endpoint |
string |
Punto de conexión del servicio. |
| type | string: |
Tipo de servicio de destino. |
ConfluentSchemaRegistry
Las propiedades del servicio cuando el tipo de servicio de destino es ConfluentSchemaRegistry
| Nombre | Tipo | Description |
|---|---|---|
| endpoint |
string |
Punto de conexión del servicio. |
| type | string: |
Tipo de servicio de destino. |
createdByType
Tipo de identidad que creó el recurso.
| Valor | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DaprMetadata
Metadatos del componente dapr.
| Nombre | Tipo | Description |
|---|---|---|
| name |
string |
Nombre de propiedad de metadatos. |
| secretRef |
string |
Nombre del secreto donde dapr podría obtener el valor |
| value |
string |
Valor de propiedad de metadatos. |
DaprProperties
Indica algunas propiedades adicionales para el tipo de cliente dapr.
| Nombre | Tipo | Description |
|---|---|---|
| componentType |
string |
Tipo de componente dapr |
| metadata |
Metadatos de dapr adicionales |
|
| scopes |
string[] |
Ámbitos del componente dapr |
| secretStoreComponent |
string |
Nombre de un dapr del almacén de secretos para recuperar el secreto. |
| version |
string |
Versión del componente dapr |
DeleteOrUpdateBehavior
Comportamiento de limpieza para indicar si la operación de limpieza se elimina o actualiza el recurso.
| Valor | Description |
|---|---|
| Default | |
| ForcedCleanup |
ErrorAdditionalInfo
Información adicional sobre el error de administración de recursos.
| Nombre | Tipo | Description |
|---|---|---|
| info |
object |
Información adicional. |
| type |
string |
Tipo de información adicional. |
ErrorDetail
Detalle del error.
| Nombre | Tipo | Description |
|---|---|---|
| additionalInfo |
Información adicional del error. |
|
| code |
string |
Código de error. |
| details |
Detalles del error. |
|
| message |
string |
Mensaje de error. |
| target |
string |
Destino del error. |
ErrorResponse
Respuesta de error
| Nombre | Tipo | Description |
|---|---|---|
| error |
Objeto de error. |
FirewallRules
Reglas de firewall del servicio de destino. para permitir conexiones desde el servicio de origen.
| Nombre | Tipo | Description |
|---|---|---|
| azureServices |
Permitir que los servicios de Azure accedan al servicio de destino si es true. |
|
| callerClientIP |
Permitir que la dirección IP del cliente de llamada acceda al servicio de destino si es true. la propiedad se usa al conectar la aplicación local al servicio de destino. |
|
| ipRanges |
string[] |
Este valor especifica el conjunto de direcciones IP o intervalos de direcciones IP en formato CIDR que se incluirá como la lista de direcciones IP de cliente permitidas para una cuenta de base de datos determinada. |
KeyVaultSecretReferenceSecretInfo
Información secreta cuando el tipo es keyVaultSecretReference. Es para el escenario en el que el usuario proporciona un secreto almacenado en el almacén de claves del usuario y el origen es Azure Kubernetes. El identificador de recurso de Key Vault está vinculado a secretStore.keyVaultId.
| Nombre | Tipo | Description |
|---|---|---|
| name |
string |
Nombre del secreto de Key Vault. |
| secretType |
string:
key |
Tipo de secreto. |
| version |
string |
Versión del secreto de Key Vault. |
KeyVaultSecretUriSecretInfo
Información secreta cuando el tipo es keyVaultSecretUri. Es para escenarios en los que el usuario proporciona un secreto almacenado en el almacén de claves del usuario y el origen es Web App, Spring Cloud o Container App.
| Nombre | Tipo | Description |
|---|---|---|
| secretType |
string:
key |
Tipo de secreto. |
| value |
string |
URI al secreto del almacén de claves |
LinkerResource
Enlazador del recurso de origen y destino
| Nombre | Tipo | Description |
|---|---|---|
| id |
string |
Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| name |
string |
Nombre del recurso |
| properties.authInfo | AuthInfoBase: |
Tipo de autenticación. |
| properties.clientType |
Tipo de cliente de aplicación |
|
| properties.configurationInfo |
La información de conexión consumida por las aplicaciones, incluidos los secretos, las cadenas de conexión. |
|
| properties.provisioningState |
string |
Estado de aprovisionamiento. |
| properties.publicNetworkSolution |
Solución de red. |
|
| properties.scope |
string |
ámbito de conexión en el servicio de origen. |
| properties.secretStore |
Una opción para almacenar el valor secreto en un lugar seguro |
|
| properties.targetService | TargetServiceBase: |
Propiedades del servicio de destino |
| properties.vNetSolution |
La solución de red virtual. |
|
| systemData |
Datos del sistema. |
|
| type |
string |
Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
PublicNetworkSolution
Indica la solución de red pública, incluir reglas de firewall.
| Nombre | Tipo | Description |
|---|---|---|
| action |
Opcional. Indica la solución de red pública. Si está habilitado, habilite el acceso a la red pública del servicio de destino con el mejor intento. El valor predeterminado es habilitar. Si opta por no participar, opte por la configuración de acceso a la red pública. |
|
| deleteOrUpdateBehavior |
Indica si se debe limpiar la operación anterior (por ejemplo, las reglas de firewall) cuando Linker está actualizando o eliminando. |
|
| firewallRules |
Describir las reglas de firewall del servicio de destino para asegurarse de que la aplicación de origen podría conectarse al destino. |
SecretAuthInfo
La información de autenticación cuando authType es secreto
| Nombre | Tipo | Description |
|---|---|---|
| authType |
string:
secret |
Tipo de autenticación. |
| name |
string |
Nombre de usuario o cuenta para la autenticación secreta. |
| secretInfo | SecretInfoBase: |
Contraseña o secreto del almacén de claves para la autenticación secreta. |
SecretStore
Una opción para almacenar el valor secreto en un lugar seguro
| Nombre | Tipo | Description |
|---|---|---|
| keyVaultId |
string |
Identificador del almacén de claves que se va a almacenar el secreto |
| keyVaultSecretName |
string |
El nombre del secreto del almacén de claves para almacenar el secreto, solo válido al almacenar un secreto. |
SecretType
Tipo de secreto.
| Valor | Description |
|---|---|
| rawValue | |
| keyVaultSecretUri | |
| keyVaultSecretReference |
SelfHostedServer
Las propiedades del servicio cuando el tipo de servicio de destino es SelfHostedServer
| Nombre | Tipo | Description |
|---|---|---|
| endpoint |
string |
Punto de conexión del servicio. |
| type | string: |
Tipo de servicio de destino. |
ServicePrincipalCertificateAuthInfo
La información de autenticación cuando authType es el certificado servicePrincipal
| Nombre | Tipo | Description |
|---|---|---|
| authType |
string:
service |
Tipo de autenticación. |
| certificate |
string |
Certificado ServicePrincipal para la autenticación servicePrincipal. |
| clientId |
string |
ClientId de aplicación para la autenticación servicePrincipal. |
| deleteOrUpdateBehavior |
Indica si se va a limpiar la operación anterior cuando Linker está actualizando o eliminando. |
|
| principalId |
string |
Identificador de entidad de seguridad para la autenticación de servicePrincipal. |
| roles |
string[] |
Opcional, este valor especifica los roles de Azure que se asignarán. Automáticamente |
ServicePrincipalSecretAuthInfo
La información de autenticación cuando authType es servicePrincipal secret
| Nombre | Tipo | Description |
|---|---|---|
| authType |
string:
service |
Tipo de autenticación. |
| clientId |
string |
ClientId de la aplicación ServicePrincipal para la autenticación de servicePrincipal. |
| deleteOrUpdateBehavior |
Indica si se va a limpiar la operación anterior cuando Linker está actualizando o eliminando. |
|
| principalId |
string |
Identificador de entidad de seguridad para la autenticación de servicePrincipal. |
| roles |
string[] |
Opcional, este valor especifica los roles de Azure que se asignarán. Automáticamente |
| secret |
string |
Secreto para la autenticación servicePrincipal. |
| userName |
string |
Nombre de usuario creado en la base de datos que se asigna a un usuario de AAD. |
SystemAssignedIdentityAuthInfo
La información de autenticación cuando authType es systemAssignedIdentity
| Nombre | Tipo | Description |
|---|---|---|
| authType |
string:
system |
Tipo de autenticación. |
| deleteOrUpdateBehavior |
Indica si se va a limpiar la operación anterior cuando Linker está actualizando o eliminando. |
|
| roles |
string[] |
Opcional, este valor especifica el rol de Azure que se va a asignar. |
| userName |
string |
Nombre de usuario creado en la base de datos que se asigna a un usuario de AAD. |
systemData
Metadatos relativos a la creación y última modificación del recurso.
| Nombre | Tipo | Description |
|---|---|---|
| createdAt |
string (date-time) |
Marca de tiempo de creación de recursos (UTC). |
| createdBy |
string |
Identidad que creó el recurso. |
| createdByType |
Tipo de identidad que creó el recurso. |
|
| lastModifiedAt |
string (date-time) |
Marca de tiempo de la última modificación del recurso (UTC) |
| lastModifiedBy |
string |
Identidad que modificó por última vez el recurso. |
| lastModifiedByType |
Tipo de identidad que modificó por última vez el recurso. |
UserAccountAuthInfo
La información de autenticación cuando authType es una cuenta de usuario
| Nombre | Tipo | Description |
|---|---|---|
| authType |
string:
user |
Tipo de autenticación. |
| deleteOrUpdateBehavior |
Indica si se va a limpiar la operación anterior cuando Linker está actualizando o eliminando. |
|
| principalId |
string |
Identificador de entidad de seguridad de la cuenta de usuario. |
| roles |
string[] |
Opcional, este valor especifica los roles de Azure que se asignarán. Automáticamente |
| userName |
string |
Nombre de usuario creado en la base de datos que se asigna a un usuario de AAD. |
UserAssignedIdentityAuthInfo
La información de autenticación cuando authType es userAssignedIdentity
| Nombre | Tipo | Description |
|---|---|---|
| authType |
string:
user |
Tipo de autenticación. |
| clientId |
string |
Id. de cliente para userAssignedIdentity. |
| deleteOrUpdateBehavior |
Indica si se va a limpiar la operación anterior cuando Linker está actualizando o eliminando. |
|
| roles |
string[] |
Opcional, este valor especifica el rol de Azure que se va a asignar. |
| subscriptionId |
string |
Identificador de suscripción para userAssignedIdentity. |
| userName |
string |
Nombre de usuario creado en la base de datos que se asigna a un usuario de AAD. |
ValueSecretInfo
Información secreta cuando el tipo es rawValue. Es para escenarios en los que el usuario escribe el secreto.
| Nombre | Tipo | Description |
|---|---|---|
| secretType |
string:
raw |
Tipo de secreto. |
| value |
string |
Valor real del secreto. |
VNetSolution
Solución de red virtual para enlazador
| Nombre | Tipo | Description |
|---|---|---|
| deleteOrUpdateBehavior |
Indica si se va a limpiar la operación anterior cuando Linker está actualizando o eliminando. |
|
| type |
Tipo de solución de red virtual. |
vNetSolutionType
Tipo de solución de red virtual.
| Valor | Description |
|---|---|
| serviceEndpoint | |
| privateLink |