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 dá suporte à configuração do aplicativo e do serviço de destino durante o provisionamento de recursos.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceUri	path	True	string	O identificador totalmente qualificado do Azure Resource Manager 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

Nome	Tipo	Description
200 OK	ResourceList	Detalhes do vinculador.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

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 de exemplo

Código de status:: 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

Nome	Description
AccessKeyInfoBase	A chave de acesso diretamente das propriedades de recurso de destino, que servem de destino, é o Recurso do Azure, como Microsoft.Storage
accessKeyPermissions	Permissões do accessKey. `Read` e `Write` são para o Azure Cosmos DB e a Configuração de Aplicativos 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 a 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 é habilitar. Se optOut, opte pela configuração de acesso à rede pública.
allowType	Permitir 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 de recurso do 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	As informações adicionais do erro de gerenciamento de recursos.
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 o tipo é keyVaultSecretReference. É para o cenário que o usuário fornece um segredo armazenado no keyvault do usuário e a origem é o Kubernetes do Azure. A ID de recurso do Key Vault está vinculada a secretStore.keyVaultId.
KeyVaultSecretUriSecretInfo	As informações secretas quando o tipo é keyVaultSecretUri. É para o cenário que o usuário fornece um segredo armazenado no keyvault do usuário e a origem é Aplicativo Web, Spring Cloud ou Aplicativo de Contêiner.
LinkerResource	Vinculador do recurso de origem e de destino
PublicNetworkSolution	Indica solução de rede pública, incluir regras de firewall
ResourceList	A lista de Vinculador.
SecretAuthInfo	As informações de autenticação quando authType é secreta
SecretStore	Uma opção para armazenar o valor do segredo em um local seguro
SecretType	O tipo de segredo.
SelfHostedServer	As propriedades de serviço quando o tipo de serviço de destino é SelfHostedServer
ServicePrincipalCertificateAuthInfo	As informações de autenticação quando authType é um certificado servicePrincipal
ServicePrincipalSecretAuthInfo	As informações de autenticação quando authType é o segredo servicePrincipal
SystemAssignedIdentityAuthInfo	As informações de autenticação quando authType é systemAssignedIdentity
systemData	Metadados relativos à 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 o tipo é rawValue. É para cenários que o usuário insira o segredo.
VNetSolution	A solução VNet para vinculador
vNetSolutionType	Tipo de solução de VNet.

AccessKeyInfoBase

Objeto

A chave de acesso diretamente das propriedades de recurso de destino, que servem de destino, é o Recurso do Azure, como Microsoft.Storage

Nome	Tipo	Description
authType	string: accessKey	O tipo de autenticação.
permissions	accessKeyPermissions[]	Permissões do accessKey. `Read` e `Write` são para o Azure Cosmos DB e a Configuração de Aplicativos 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 do accessKey. Read e Write são para o Azure Cosmos DB e a Configuração de Aplicativos 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 a 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 é habilitar. Se optOut, opte pela configuração de acesso à rede pública.

Valor	Description
enable
optOut

allowType

Enumeração

Permitir 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

Objeto

As propriedades do recurso quando o tipo é Azure Key Vault

Nome	Tipo	Description
connectAsKubernetesCsiDriver	boolean	True se conectar por meio do Driver CSI do Kubernetes.
type	string: KeyVault	O tipo de recurso do azure.

AzureResource

Objeto

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

Nome	Tipo	Description
id	string	A ID do recurso do Azure.
resourceProperties	AzureResourcePropertiesBase: AzureKeyVaultProperties	As propriedades relacionadas à conexão de recurso 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

Objeto

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

Nome	Tipo	Description
action	actionType	Opcional, indique se as configurações devem ser aplicadas no aplicativo de origem. Se habilitar, gere configurações e aplique ao aplicativo de origem. O padrão é habilitar. Se optOut, nenhuma alteração de configuração será feita na origem.
additionalConfigurations	object	Um dicionário de configurações adicionais a serem adicionadas. O serviço gerará automaticamente um conjunto de configurações básicas e essa propriedade será preenchida com 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 Vinculador estiver atualizando ou excluindo

ConfluentBootstrapServer

Objeto

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

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

ConfluentSchemaRegistry

Objeto

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

Nome	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

Objeto

Os metadados do componente dapr.

Nome	Tipo	Description
name	string	Nome da propriedade de metadados.
secretRef	string	O nome do segredo em que a dapr pode obter valor
value	string	Valor da propriedade de metadados.

DaprProperties

Objeto

Indica algumas propriedades adicionais para o tipo de cliente dapr

Nome	Tipo	Description
componentType	string	O tipo de componente dapr
metadata	DaprMetadata[]	Metadados adicionais de dapr
scopes	string[]	Os escopos do componente dapr
secretStoreComponent	string	O nome de um dapr do repositório secreto para recuperar o 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

Objeto

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

FirewallRules

Objeto

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

Nome	Tipo	Description
azureServices	allowType	Permitir que os serviços do Azure acessem o serviço de destino se verdadeiro.
callerClientIP	allowType	Permitir que o IP do cliente do 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 do cliente para uma determinada conta de banco de dados.

KeyVaultSecretReferenceSecretInfo

Objeto

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

Nome	Tipo	Description
name	string	Nome do segredo do Key Vault.
secretType	string: keyVaultSecretReference	O tipo de segredo.
version	string	Versão do segredo do Key Vault.

KeyVaultSecretUriSecretInfo

Objeto

As informações secretas quando o tipo é keyVaultSecretUri. É para o cenário que o usuário fornece um segredo armazenado no keyvault do usuário e a origem é Aplicativo Web, Spring Cloud ou Aplicativo de Contêiner.

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

LinkerResource

Objeto

Vinculador do recurso de origem e de destino

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada 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 de conexão no serviço de origem.
properties.secretStore	SecretStore	Uma opção para armazenar o valor do segredo em um 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

Objeto

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

Nome	Tipo	Description
action	actionType	Opcional. Indica a 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 é habilitar. Se optOut, opte pela configuração de acesso à rede pública.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indica se a operação anterior (como regras de firewall) deve ser limpa quando o Vinculador estiver 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

Objeto

A lista de Vinculador.

Nome	Tipo	Description
nextLink	string	O Vinculador usado para obter a próxima página da lista do Vinculador.
value	LinkerResource[]	A lista de Vinculadores.

SecretAuthInfo

Objeto

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

Nome	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

Objeto

Uma opção para armazenar o valor do segredo em um local seguro

Nome	Tipo	Description
keyVaultId	string	A ID do cofre de chaves para armazenar o segredo
keyVaultSecretName	string	O nome do segredo do cofre de chaves para armazenar o segredo, válido somente ao armazenar um segredo

SecretType

Enumeração

O tipo de segredo.

Valor	Description
rawValue
keyVaultSecretUri
keyVaultSecretReference

SelfHostedServer

Objeto

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

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

ServicePrincipalCertificateAuthInfo

Objeto

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

Nome	Tipo	Description
authType	string: servicePrincipalCertificate	O tipo de autenticação.
certificate	string	Certificado ServicePrincipal para autenticação servicePrincipal.
clientId	string	ClientId de aplicativo para autenticação servicePrincipal.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indica se a operação anterior deve ser limpa quando o Vinculador estiver atualizando ou excluindo
principalId	string	ID da entidade de segurança para autenticação servicePrincipal.
roles	string[]	Opcional, esse valor especifica as funções do Azure a serem atribuídas. Automaticamente

ServicePrincipalSecretAuthInfo

Objeto

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

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

SystemAssignedIdentityAuthInfo

Objeto

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

Nome	Tipo	Description
authType	string: systemAssignedIdentity	O tipo de autenticação.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indica se a operação anterior deve ser limpa quando o Vinculador 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

Objeto

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

Nome	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

Objeto

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

Nome	Tipo	Description
authType	string: userAccount	O tipo de autenticação.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indica se a operação anterior deve ser limpa quando o Vinculador estiver atualizando ou excluindo
principalId	string	ID da entidade de segurança 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

Objeto

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

Nome	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 Vinculador estiver atualizando ou excluindo
roles	string[]	Opcional, esse valor especifica a função do Azure a ser atribuída
subscriptionId	string	ID da assinatura para userAssignedIdentity.
userName	string	Nome de usuário criado no banco de dados que é mapeado para um usuário no AAD.

ValueSecretInfo

Objeto

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

Nome	Tipo	Description
secretType	string: rawValue	O tipo de segredo.
value	string	O valor real do segredo.

VNetSolution

Objeto

A solução VNet para vinculador

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

vNetSolutionType

Enumeração

Tipo de solução de VNet.

Valor	Description
serviceEndpoint
privateLink

Compartilhar via

Linker - List

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

LinkerList

Solicitação de exemplo

Resposta de exemplo

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