Linker - List

Serviço:: Service Connector

Versão da API:: 2022-11-01-preview

Retorna a lista de Vinculadores que se conecta ao recurso. que suporta a configuração do aplicativo e do serviço de destino durante o fornecimento de recursos.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceUri	path	True	string	O identificador totalmente qualificado do Gerenciador de Recursos do Azure do recurso a ser conectado.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	ResourceList	Detalhes do linker.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

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

Resposta da amostra

Código de estado:: 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"
      }
    }
  ]
}

Definições

Name	Description
AccessKeyInfoBase	A chave de acesso diretamente das propriedades do recurso de destino, cujo serviço de destino é o Recurso do Azure, como Microsoft.Storage
accessKeyPermissions	Permissões da accessKey. `Read` e `Write` são para o Azure Cosmos DB e a Configuração de Aplicativo do Azure, `Listen`, `Send` e `Manage` são para o Hub de Eventos do Azure e o Barramento de Serviço do Azure.
actionType	Opcional. Indica solução de rede pública. Se habilitar, habilite o acesso à rede pública do serviço de destino com a melhor tentativa. O padrão é habilitado. Em caso de desativação, desative a configuração de acesso à rede pública.
allowType	Permita que os serviços do Azure acessem o serviço de destino, se verdadeiro.
AuthType	O tipo de autenticação.
AzureKeyVaultProperties	As propriedades do recurso quando o tipo é Azure Key Vault
AzureResource	As informações do recurso azure quando o tipo de serviço de destino é AzureResource
clientType	O tipo de cliente do aplicativo
ConfigurationInfo	As informações de configuração, usadas para gerar configurações ou salvar em aplicativos
ConfluentBootstrapServer	As propriedades de serviço quando o tipo de serviço de destino é ConfluentBootstrapServer
ConfluentSchemaRegistry	As propriedades de serviço quando o tipo de serviço de destino é ConfluentSchemaRegistry
createdByType	O tipo de identidade que criou o recurso.
DaprMetadata	Os metadados do componente dapr.
DaprProperties	Indica algumas propriedades adicionais para o tipo de cliente dapr
DeleteOrUpdateBehavior	O comportamento de limpeza para indicar se a operação de limpeza quando o recurso é excluído ou atualizado
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
FirewallRules	Regras de firewall do serviço de destino. para permitir conexões do serviço de origem.
KeyVaultSecretReferenceSecretInfo	As informações secretas quando tipo é keyVaultSecretReference. É para o cenário que o usuário fornece um segredo armazenado no cofre da chave do usuário e a origem é o Kubernetes do Azure. A chave ID de recurso do Vault está vinculada a secretStore.keyVaultId.
KeyVaultSecretUriSecretInfo	As informações secretas quando tipo é keyVaultSecretUri. É para o cenário que o usuário fornece um segredo armazenado no keyvault do usuário e a fonte é Web App, Spring Cloud ou Container App.
LinkerResource	Vinculador do recurso de origem e de destino
PublicNetworkSolution	Indica solução de rede pública, inclui regras de firewall
ResourceList	A lista de Linker.
SecretAuthInfo	As informações de autenticação quando authType é secreto
SecretStore	Uma opção para armazenar valor secreto em local seguro
SecretType	O tipo secreto.
SelfHostedServer	As propriedades de serviço quando o tipo de serviço de destino é SelfHostedServer
ServicePrincipalCertificateAuthInfo	As informações de autenticação quando authType é certificado servicePrincipal
ServicePrincipalSecretAuthInfo	As informações de autenticação quando authType é servicePrincipal secret
SystemAssignedIdentityAuthInfo	As informações de autenticação quando authType é systemAssignedIdentity
systemData	Metadados referentes à criação e última modificação do recurso.
UserAccountAuthInfo	As informações de autenticação quando authType é conta de usuário
UserAssignedIdentityAuthInfo	As informações de autenticação quando authType é userAssignedIdentity
ValueSecretInfo	As informações secretas quando type é rawValue. É para cenários que o usuário insere o segredo.
VNetSolution	A solução VNet para linker
vNetSolutionType	Tipo de solução VNet.

AccessKeyInfoBase

Object

A chave de acesso diretamente das propriedades do recurso de destino, cujo serviço de destino é o Recurso do Azure, como Microsoft.Storage

Name	Tipo	Description
authType	string: accessKey	O tipo de autenticação.
permissions	accessKeyPermissions[]	Permissões da accessKey. `Read` e `Write` são para o Azure Cosmos DB e a Configuração de Aplicativo do Azure, `Listen`, `Send` e `Manage` são para o Hub de Eventos do Azure e o Barramento de Serviço do Azure.

accessKeyPermissions

Enumeração

Permissões da accessKey. Read e Write são para o Azure Cosmos DB e a Configuração de Aplicativo do Azure, Listen, Send e Manage são para o Hub de Eventos do Azure e o Barramento de Serviço do Azure.

Valor	Description
Read
Write
Listen
Send
Manage

actionType

Enumeração

Opcional. Indica solução de rede pública. Se habilitar, habilite o acesso à rede pública do serviço de destino com a melhor tentativa. O padrão é habilitado. Em caso de desativação, desative a configuração de acesso à rede pública.

Valor	Description
enable
optOut

allowType

Enumeração

Permita que os serviços do Azure acessem o serviço de destino, se verdadeiro.

Valor	Description
true
false

AuthType

Enumeração

O tipo de autenticação.

Valor	Description
systemAssignedIdentity
userAssignedIdentity
servicePrincipalSecret
servicePrincipalCertificate
secret
accessKey
userAccount

AzureKeyVaultProperties

Object

As propriedades do recurso quando o tipo é Azure Key Vault

Name	Tipo	Description
connectAsKubernetesCsiDriver	boolean	True se conectar via Kubernetes CSI Driver.
type	string: KeyVault	O tipo de recurso azure.

AzureResource

Object

As informações do recurso azure quando o tipo de serviço de destino é AzureResource

Name	Tipo	Description
id	string	O Id do recurso azure.
resourceProperties	AzureResourcePropertiesBase: AzureKeyVaultProperties	As propriedades relacionadas à conexão de recursos do azure.
type	string: AzureResource	O tipo de serviço de destino.

clientType

Enumeração

O tipo de cliente do aplicativo

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

ConfigurationInfo

Object

As informações de configuração, usadas para gerar configurações ou salvar em aplicativos

Name	Tipo	Description
action	actionType	Opcional, indique se as configurações devem ser aplicadas no aplicativo de origem. Se habilitar, gere configurações e aplicadas ao aplicativo de origem. O padrão é habilitado. Se optOut, nenhuma alteração de configuração será feita na fonte.
additionalConfigurations	object	Um dicionário de configurações adicionais a serem adicionadas. O serviço irá gerar automaticamente um conjunto de configurações básicas e esta propriedade é para preencher completamente mais configurações personalizadas
customizedKeys	object	Opcional. Um dicionário de nome de chave padrão e mapeamento de nome de chave personalizado. Se não for especificado, o nome da chave padrão será usado para gerar configurações
daprProperties	DaprProperties	Indica algumas propriedades adicionais para o tipo de cliente dapr
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indica se a operação anterior deve ser limpa quando o Linker estiver atualizando ou excluindo

ConfluentBootstrapServer

Object

As propriedades de serviço quando o tipo de serviço de destino é ConfluentBootstrapServer

Name	Tipo	Description
endpoint	string	O ponto de extremidade do serviço.
type	string: ConfluentBootstrapServer	O tipo de serviço de destino.

ConfluentSchemaRegistry

Object

As propriedades de serviço quando o tipo de serviço de destino é ConfluentSchemaRegistry

Name	Tipo	Description
endpoint	string	O ponto de extremidade do serviço.
type	string: ConfluentSchemaRegistry	O tipo de serviço de destino.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DaprMetadata

Object

Os metadados do componente dapr.

Name	Tipo	Description
name	string	Nome da propriedade Metadata.
secretRef	string	O nome secreto onde dapr poderia obter valor
value	string	Valor da propriedade Metadata.

DaprProperties

Object

Indica algumas propriedades adicionais para o tipo de cliente dapr

Name	Tipo	Description
componentType	string	O tipo de componente dapr
metadata	DaprMetadata[]	Metadados dapr adicionais
scopes	string[]	Os escopos do componente dapr
secretStoreComponent	string	O nome de uma loja secreta dapr para recuperar segredo
version	string	A versão do componente dapr

DeleteOrUpdateBehavior

Enumeração

O comportamento de limpeza para indicar se a operação de limpeza quando o recurso é excluído ou atualizado

Valor	Description
Default
ForcedCleanup

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

FirewallRules

Object

Regras de firewall do serviço de destino. para permitir conexões do serviço de origem.

Name	Tipo	Description
azureServices	allowType	Permita que os serviços do Azure acessem o serviço de destino, se verdadeiro.
callerClientIP	allowType	Permita que o IP do cliente chamador acesse o serviço de destino, se verdadeiro. A propriedade é usada ao conectar o aplicativo local ao serviço de destino.
ipRanges	string[]	Esse valor especifica o conjunto de endereços IP ou intervalos de endereços IP no formulário CIDR a ser incluído como a lista permitida de IPs de cliente para uma determinada conta de banco de dados.

KeyVaultSecretReferenceSecretInfo

Object

As informações secretas quando tipo é keyVaultSecretReference. É para o cenário que o usuário fornece um segredo armazenado no cofre da chave do usuário e a origem é o Kubernetes do Azure. A chave ID de recurso do Vault está vinculada a secretStore.keyVaultId.

Name	Tipo	Description
name	string	Nome do segredo do Cofre da Chave.
secretType	string: keyVaultSecretReference	O tipo secreto.
version	string	Versão do segredo do Cofre da Chave.

KeyVaultSecretUriSecretInfo

Object

As informações secretas quando tipo é keyVaultSecretUri. É para o cenário que o usuário fornece um segredo armazenado no keyvault do usuário e a fonte é Web App, Spring Cloud ou Container App.

Name	Tipo	Description
secretType	string: keyVaultSecretUri	O tipo secreto.
value	string	URI para o segredo do keyvault

LinkerResource

Object

Vinculador do recurso de origem e de destino

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.authInfo	AuthInfoBase: AccessKeyInfoBase SecretAuthInfo ServicePrincipalCertificateAuthInfo ServicePrincipalSecretAuthInfo SystemAssignedIdentityAuthInfo UserAccountAuthInfo UserAssignedIdentityAuthInfo	O tipo de autenticação.
properties.clientType	clientType	O tipo de cliente do aplicativo
properties.configurationInfo	ConfigurationInfo	As informações de conexão consumidas por aplicativos, incluindo segredos, cadeias de conexão.
properties.provisioningState	string	O estado de provisionamento.
properties.publicNetworkSolution	PublicNetworkSolution	A solução de rede.
properties.scope	string	escopo da conexão no serviço de origem.
properties.secretStore	SecretStore	Uma opção para armazenar valor secreto em local seguro
properties.targetService	TargetServiceBase: AzureResource ConfluentBootstrapServer ConfluentSchemaRegistry SelfHostedServer	As propriedades do serviço de destino
properties.vNetSolution	VNetSolution	A solução VNet.
systemData	systemData	Os dados do sistema.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PublicNetworkSolution

Object

Indica solução de rede pública, inclui regras de firewall

Name	Tipo	Description
action	actionType	Opcional. Indica solução de rede pública. Se habilitar, habilite o acesso à rede pública do serviço de destino com a melhor tentativa. O padrão é habilitado. Em caso de desativação, desative a configuração de acesso à rede pública.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indica se a operação anterior deve ser limpa (como regras de firewall) quando o Linker está atualizando ou excluindo
firewallRules	FirewallRules	Descreva as regras de firewall do serviço de destino para garantir que o aplicativo de origem possa se conectar ao destino.

ResourceList

Object

A lista de Linker.

Name	Tipo	Description
nextLink	string	O Linker usado para obter a próxima página da lista Linker.
value	LinkerResource[]	A lista de Linkers.

SecretAuthInfo

Object

As informações de autenticação quando authType é secreto

Name	Tipo	Description
authType	string: secret	O tipo de autenticação.
name	string	Nome de usuário ou nome de conta para autenticação secreta.
secretInfo	SecretInfoBase: KeyVaultSecretReferenceSecretInfo KeyVaultSecretUriSecretInfo ValueSecretInfo	Senha ou segredo do cofre de chaves para autenticação secreta.

SecretStore

Object

Uma opção para armazenar valor secreto em local seguro

Name	Tipo	Description
keyVaultId	string	O ID do cofre de chaves para armazenar segredo
keyVaultSecretName	string	O nome secreto do cofre de chaves para armazenar segredo, válido apenas ao armazenar um segredo

SecretType

Enumeração

O tipo secreto.

Valor	Description
rawValue
keyVaultSecretUri
keyVaultSecretReference

SelfHostedServer

Object

As propriedades de serviço quando o tipo de serviço de destino é SelfHostedServer

Name	Tipo	Description
endpoint	string	O ponto de extremidade do serviço.
type	string: SelfHostedServer	O tipo de serviço de destino.

ServicePrincipalCertificateAuthInfo

Object

As informações de autenticação quando authType é certificado servicePrincipal

Name	Tipo	Description
authType	string: servicePrincipalCertificate	O tipo de autenticação.
certificate	string	Certificado ServicePrincipal para servicePrincipal auth.
clientId	string	Application clientId for servicePrincipal auth.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indica se a operação anterior deve ser limpa quando o Linker estiver atualizando ou excluindo
principalId	string	Principal Id para servicePrincipal auth.
roles	string[]	Opcional, esse valor especifica as funções do Azure a serem atribuídas. Automaticamente

ServicePrincipalSecretAuthInfo

Object

As informações de autenticação quando authType é servicePrincipal secret

Name	Tipo	Description
authType	string: servicePrincipalSecret	O tipo de autenticação.
clientId	string	ServicePrincipal application clientId for servicePrincipal auth.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indica se a operação anterior deve ser limpa quando o Linker estiver atualizando ou excluindo
principalId	string	Principal Id para servicePrincipal auth.
roles	string[]	Opcional, esse valor especifica as funções do Azure a serem atribuídas. Automaticamente
secret	string	Segredo para o serviçoPrincipal auth.
userName	string	Nome de usuário criado no banco de dados que é mapeado para um usuário no AAD.

SystemAssignedIdentityAuthInfo

Object

As informações de autenticação quando authType é systemAssignedIdentity

Name	Tipo	Description
authType	string: systemAssignedIdentity	O tipo de autenticação.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indica se a operação anterior deve ser limpa quando o Linker estiver atualizando ou excluindo
roles	string[]	Opcional, esse valor especifica a função do Azure a ser atribuída
userName	string	Nome de usuário criado no banco de dados que é mapeado para um usuário no AAD.

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UserAccountAuthInfo

Object

As informações de autenticação quando authType é conta de usuário

Name	Tipo	Description
authType	string: userAccount	O tipo de autenticação.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indica se a operação anterior deve ser limpa quando o Linker estiver atualizando ou excluindo
principalId	string	ID principal da conta de usuário.
roles	string[]	Opcional, esse valor especifica as funções do Azure a serem atribuídas. Automaticamente
userName	string	Nome de usuário criado no banco de dados que é mapeado para um usuário no AAD.

UserAssignedIdentityAuthInfo

Object

As informações de autenticação quando authType é userAssignedIdentity

Name	Tipo	Description
authType	string: userAssignedIdentity	O tipo de autenticação.
clientId	string	ID do cliente para userAssignedIdentity.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indica se a operação anterior deve ser limpa quando o Linker estiver atualizando ou excluindo
roles	string[]	Opcional, esse valor especifica a função do Azure a ser atribuída
subscriptionId	string	ID de assinatura para userAssignedIdentity.
userName	string	Nome de usuário criado no banco de dados que é mapeado para um usuário no AAD.

ValueSecretInfo

Object

As informações secretas quando type é rawValue. É para cenários que o usuário insere o segredo.

Name	Tipo	Description
secretType	string: rawValue	O tipo secreto.
value	string	O valor real do segredo.

VNetSolution

Object

A solução VNet para linker

Name	Tipo	Description
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indica se a operação anterior deve ser limpa quando o Linker estiver atualizando ou excluindo
type	vNetSolutionType	Tipo de solução VNet.

vNetSolutionType

Enumeração

Tipo de solução VNet.

Valor	Description
serviceEndpoint
privateLink

Partilhar via

Linker - List

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

LinkerList

Pedido de amostra

Resposta da amostra

Definições

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