Linker - List

Servicio:: Service Connector

Versión de la API:: 2022-11-01-preview

Devuelve la lista de enlazadores que se conecta al recurso. que admite la configuración tanto de la aplicación como del servicio de destino durante el aprovisionamiento de recursos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceUri	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.

Respuestas

Nombre	Tipo	Description
200 OK	ResourceList	Detalles del enlazador.
Other Status Codes	ErrorResponse	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

LinkerList

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/linkers?api-version=2022-11-01-preview

from azure.identity import DefaultAzureCredential
from azure.mgmt.servicelinker import ServiceLinkerManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicelinker
# USAGE
    python linker_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ServiceLinkerManagementClient(
        credential=DefaultAzureCredential(),
    )

    response = client.linker.list(
        resource_uri="subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2022-11-01-preview/examples/LinkerList.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/links/linkName",
      "name": "linkName",
      "type": "Microsoft.ServiceLinker/links",
      "properties": {
        "authInfo": {
          "authType": "secret",
          "name": "username"
        },
        "targetService": {
          "type": "AzureResource",
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
        }
      },
      "systemData": {
        "createdAt": "2020-07-12T22:05:09Z"
      }
    }
  ]
}

Definiciones

Nombre	Description
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.
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.
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.
allowType	Permitir que los servicios de Azure accedan al servicio de destino si es true.
AuthType	Tipo de autenticación.
AzureKeyVaultProperties	Propiedades de recurso cuando el tipo es Azure Key Vault
AzureResource	La información del recurso de Azure cuando el tipo de servicio de destino es AzureResource
clientType	Tipo de cliente de aplicación
ConfigurationInfo	La información de configuración, que se usa para generar configuraciones o guardar en aplicaciones
ConfluentBootstrapServer	Las propiedades del servicio cuando el tipo de servicio de destino es ConfluentBootstrapServer
ConfluentSchemaRegistry	Las propiedades del servicio cuando el tipo de servicio de destino es ConfluentSchemaRegistry
createdByType	Tipo de identidad que creó el recurso.
DaprMetadata	Metadatos del componente dapr.
DaprProperties	Indica algunas propiedades adicionales para el tipo de cliente dapr.
DeleteOrUpdateBehavior	Comportamiento de limpieza para indicar si la operación de limpieza se elimina o actualiza el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
FirewallRules	Reglas de firewall del servicio de destino. para permitir conexiones desde el servicio de origen.
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.
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.
LinkerResource	Enlazador del recurso de origen y destino
PublicNetworkSolution	Indica la solución de red pública, incluir reglas de firewall.
ResourceList	Lista de Enlazador.
SecretAuthInfo	La información de autenticación cuando authType es secreto
SecretStore	Una opción para almacenar el valor secreto en un lugar seguro
SecretType	Tipo de secreto.
SelfHostedServer	Las propiedades del servicio cuando el tipo de servicio de destino es SelfHostedServer
ServicePrincipalCertificateAuthInfo	La información de autenticación cuando authType es el certificado servicePrincipal
ServicePrincipalSecretAuthInfo	La información de autenticación cuando authType es servicePrincipal secret
SystemAssignedIdentityAuthInfo	La información de autenticación cuando authType es systemAssignedIdentity
systemData	Metadatos relativos a la creación y última modificación del recurso.
UserAccountAuthInfo	La información de autenticación cuando authType es una cuenta de usuario
UserAssignedIdentityAuthInfo	La información de autenticación cuando authType es userAssignedIdentity
ValueSecretInfo	Información secreta cuando el tipo es rawValue. Es para escenarios en los que el usuario escribe el secreto.
VNetSolution	Solución de red virtual para enlazador
vNetSolutionType	Tipo de solución de red virtual.

AccessKeyInfoBase

Object

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: accessKey	Tipo de autenticación.
permissions	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.

accessKeyPermissions

Enumeración

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

Enumeración

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

Enumeración

Permitir que los servicios de Azure accedan al servicio de destino si es true.

Valor	Description
true
false

AuthType

Enumeración

Tipo de autenticación.

Valor	Description
systemAssignedIdentity
userAssignedIdentity
servicePrincipalSecret
servicePrincipalCertificate
secret
accessKey
userAccount

AzureKeyVaultProperties

Object

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: KeyVault	Tipo de recurso de Azure.

AzureResource

Object

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: AzureKeyVaultProperties	Propiedades relacionadas con la conexión de recursos de Azure.
type	string: AzureResource	Tipo de servicio de destino.

clientType

Enumeración

Tipo de cliente de aplicación

Valor	Description
none
dotnet
java
python
go
php
ruby
django
nodejs
springBoot
kafka-springBoot
dapr

ConfigurationInfo

Object

La información de configuración, que se usa para generar configuraciones o guardar en aplicaciones

Nombre	Tipo	Description
action	actionType	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	DaprProperties	Indica algunas propiedades adicionales para el tipo de cliente dapr.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indica si se va a limpiar la operación anterior cuando Linker está actualizando o eliminando.

ConfluentBootstrapServer

Object

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: ConfluentBootstrapServer	Tipo de servicio de destino.

ConfluentSchemaRegistry

Object

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: ConfluentSchemaRegistry	Tipo de servicio de destino.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DaprMetadata

Object

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

Object

Indica algunas propiedades adicionales para el tipo de cliente dapr.

Nombre	Tipo	Description
componentType	string	Tipo de componente dapr
metadata	DaprMetadata[]	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

Enumeración

Comportamiento de limpieza para indicar si la operación de limpieza se elimina o actualiza el recurso.

Valor	Description
Default
ForcedCleanup

ErrorAdditionalInfo

Object

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

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

FirewallRules

Object

Reglas de firewall del servicio de destino. para permitir conexiones desde el servicio de origen.

Nombre	Tipo	Description
azureServices	allowType	Permitir que los servicios de Azure accedan al servicio de destino si es true.
callerClientIP	allowType	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

Object

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: keyVaultSecretReference	Tipo de secreto.
version	string	Versión del secreto de Key Vault.

KeyVaultSecretUriSecretInfo

Object

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: keyVaultSecretUri	Tipo de secreto.
value	string	URI al secreto del almacén de claves

LinkerResource

Object

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: AccessKeyInfoBase SecretAuthInfo ServicePrincipalCertificateAuthInfo ServicePrincipalSecretAuthInfo SystemAssignedIdentityAuthInfo UserAccountAuthInfo UserAssignedIdentityAuthInfo	Tipo de autenticación.
properties.clientType	clientType	Tipo de cliente de aplicación
properties.configurationInfo	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	PublicNetworkSolution	Solución de red.
properties.scope	string	ámbito de conexión en el servicio de origen.
properties.secretStore	SecretStore	Una opción para almacenar el valor secreto en un lugar seguro
properties.targetService	TargetServiceBase: AzureResource ConfluentBootstrapServer ConfluentSchemaRegistry SelfHostedServer	Propiedades del servicio de destino
properties.vNetSolution	VNetSolution	La solución de red virtual.
systemData	systemData	Datos del sistema.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PublicNetworkSolution

Object

Indica la solución de red pública, incluir reglas de firewall.

Nombre	Tipo	Description
action	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.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indica si se debe limpiar la operación anterior (por ejemplo, las reglas de firewall) cuando Linker está actualizando o eliminando.
firewallRules	FirewallRules	Describir las reglas de firewall del servicio de destino para asegurarse de que la aplicación de origen podría conectarse al destino.

ResourceList

Object

Lista de Enlazador.

Nombre	Tipo	Description
nextLink	string	Enlazador usado para obtener la página siguiente de la lista enlazador.
value	LinkerResource[]	Lista de enlazadores.

SecretAuthInfo

Object

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: KeyVaultSecretReferenceSecretInfo KeyVaultSecretUriSecretInfo ValueSecretInfo	Contraseña o secreto del almacén de claves para la autenticación secreta.

SecretStore

Object

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

Enumeración

Tipo de secreto.

Valor	Description
rawValue
keyVaultSecretUri
keyVaultSecretReference

SelfHostedServer

Object

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: SelfHostedServer	Tipo de servicio de destino.

ServicePrincipalCertificateAuthInfo

Object

La información de autenticación cuando authType es el certificado servicePrincipal

Nombre	Tipo	Description
authType	string: servicePrincipalCertificate	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	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

Object

La información de autenticación cuando authType es servicePrincipal secret

Nombre	Tipo	Description
authType	string: servicePrincipalSecret	Tipo de autenticación.
clientId	string	ClientId de la aplicación ServicePrincipal para la autenticación de servicePrincipal.
deleteOrUpdateBehavior	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

Object

La información de autenticación cuando authType es systemAssignedIdentity

Nombre	Tipo	Description
authType	string: systemAssignedIdentity	Tipo de autenticación.
deleteOrUpdateBehavior	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

Object

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	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	createdByType	Tipo de identidad que modificó por última vez el recurso.

UserAccountAuthInfo

Object

La información de autenticación cuando authType es una cuenta de usuario

Nombre	Tipo	Description
authType	string: userAccount	Tipo de autenticación.
deleteOrUpdateBehavior	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

Object

La información de autenticación cuando authType es userAssignedIdentity

Nombre	Tipo	Description
authType	string: userAssignedIdentity	Tipo de autenticación.
clientId	string	Id. de cliente para userAssignedIdentity.
deleteOrUpdateBehavior	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

Object

Información secreta cuando el tipo es rawValue. Es para escenarios en los que el usuario escribe el secreto.

Nombre	Tipo	Description
secretType	string: rawValue	Tipo de secreto.
value	string	Valor real del secreto.

VNetSolution

Object

Solución de red virtual para enlazador

Nombre	Tipo	Description
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indica si se va a limpiar la operación anterior cuando Linker está actualizando o eliminando.
type	vNetSolutionType	Tipo de solución de red virtual.

vNetSolutionType

Enumeración

Tipo de solución de red virtual.

Valor	Description
serviceEndpoint
privateLink

Compartir a través de

Linker - List

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

LinkerList

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AccessKeyInfoBase

accessKeyPermissions

actionType

allowType

AuthType

AzureKeyVaultProperties

AzureResource

clientType

ConfigurationInfo

ConfluentBootstrapServer

ConfluentSchemaRegistry

createdByType

DaprMetadata

DaprProperties

DeleteOrUpdateBehavior

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FirewallRules

KeyVaultSecretReferenceSecretInfo

KeyVaultSecretUriSecretInfo

LinkerResource

PublicNetworkSolution

ResourceList

SecretAuthInfo

SecretStore

SecretType

SelfHostedServer

ServicePrincipalCertificateAuthInfo

ServicePrincipalSecretAuthInfo

SystemAssignedIdentityAuthInfo

systemData

UserAccountAuthInfo

UserAssignedIdentityAuthInfo

ValueSecretInfo

VNetSolution

vNetSolutionType