Compartilhar via


Linker - Create Or Update

Criar ou atualizar o recurso do Vinculador.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
linkerName
path True

string

O nome recurso do Vinculador.

resourceUri
path True

string

O identificador totalmente qualificado do Azure Resource Manager do recurso a ser conectado.

api-version
query True

string

A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome Tipo Description
properties.authInfo AuthInfoBase:

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.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 no local seguro

properties.targetService TargetServiceBase:

As propriedades do serviço de destino

properties.vNetSolution

VNetSolution

A solução de VNet.

Respostas

Nome Tipo Description
200 OK

LinkerResource

Bem sucedido.

201 Created

LinkerResource

Operação de execução prolongada.

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

PutLinker

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
AccessKeyInfoBase

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

accessKeyPermissions

Permissões do accessKey. Reade Write são para o Azure Cosmos DB e Configuração de Aplicativos do Azure, Listene SendManage são para o Hub de Eventos do Azure e 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 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 for true.

AuthType

O tipo de autenticação.

AzureKeyVaultProperties

As propriedades do recurso quando o tipo é Key Vault do Azure

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 limpo a operação 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 destino

PublicNetworkSolution

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

SecretAuthInfo

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

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 é servicePrincipal certificate

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 de VNet para o vinculador

vNetSolutionType

Tipo de solução de VNet.

AccessKeyInfoBase

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

Nome Tipo Description
authType string:

accessKey

O tipo de autenticação.

permissions

accessKeyPermissions[]

Permissões da accessKey. Reade Write são para o Azure Cosmos DB e Configuração de Aplicativos do Azure, Listene SendManage são para o Hub de Eventos do Azure e Barramento de Serviço do Azure.

accessKeyPermissions

Permissões do accessKey. Reade Write são para o Azure Cosmos DB e Configuração de Aplicativos do Azure, Listene SendManage são para o Hub de Eventos do Azure e Barramento de Serviço do Azure.

Nome Tipo Description
Listen

string

Manage

string

Read

string

Send

string

Write

string

actionType

Opcional. Indica a solução de rede pública. Se habilitar, habilite o acesso à rede pública do serviço de destino com melhor tentativa. O padrão é habilitar. Se optOut, opte pela configuração de acesso à rede pública.

Nome Tipo Description
enable

string

optOut

string

allowType

Permitir que os serviços do Azure acessem o serviço de destino, se for true.

Nome Tipo Description
false

string

true

string

AuthType

O tipo de autenticação.

Nome Tipo Description
accessKey

string

secret

string

servicePrincipalCertificate

string

servicePrincipalSecret

string

systemAssignedIdentity

string

userAccount

string

userAssignedIdentity

string

AzureKeyVaultProperties

As propriedades do recurso quando o tipo é Key Vault do Azure

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

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 recursos do azure.

type string:

AzureResource

O tipo de serviço de destino.

clientType

O tipo de cliente do aplicativo

Nome Tipo Description
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

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 deve preencher totalmente as configurações mais 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 limpo quando o Vinculador estiver atualizando ou excluindo

ConfluentBootstrapServer

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

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

O tipo de identidade que criou o recurso.

Nome Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

DaprMetadata

Os metadados do componente dapr.

Nome Tipo Description
name

string

Nome da propriedade de metadados.

secretRef

string

O nome do segredo em que o dapr pode obter valor

value

string

Valor da propriedade de metadados.

DaprProperties

Indica algumas propriedades adicionais para o tipo de cliente dapr

Nome Tipo Description
componentType

string

O tipo de componente dapr

metadata

DaprMetadata[]

Metadados adicionais do dapr

scopes

string[]

Os escopos do componente dapr

secretStoreComponent

string

O nome de um dapr do repositório de segredos para recuperar o segredo

version

string

A versão do componente dapr

DeleteOrUpdateBehavior

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

Nome Tipo Description
Default

string

ForcedCleanup

string

ErrorAdditionalInfo

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

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

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

FirewallRules

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 for true.

callerClientIP

allowType

Permitir que o IP do cliente chamador acesse o serviço de destino, se for true. 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

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 Key Vault.

secretType string:

keyVaultSecretReference

O tipo de segredo.

version

string

Versão do segredo Key Vault.

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.

Nome Tipo Description
secretType string:

keyVaultSecretUri

O tipo de segredo.

value

string

URI para o segredo do keyvault

LinkerResource

Vinculador do recurso de origem e 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:

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:

As propriedades do serviço de destino

properties.vNetSolution

VNetSolution

A solução de VNet.

systemData

systemData

Os dados do sistema.

type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PublicNetworkSolution

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 deve limpo operações anteriores (como regras de firewall) quando o Vinculador 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.

SecretAuthInfo

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

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:

Senha ou segredo do cofre de chaves para autenticação secreta.

SecretStore

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

O tipo de segredo.

Nome Tipo Description
keyVaultSecretReference

string

keyVaultSecretUri

string

rawValue

string

SelfHostedServer

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

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

Nome Tipo Description
authType string:

servicePrincipalCertificate

O tipo de autenticação.

certificate

string

Certificado ServicePrincipal para autenticação servicePrincipal.

clientId

string

Application clientId para servicePrincipal auth.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Indica se a operação anterior deve ser limpo 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

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 application clientId para servicePrincipal auth.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Indica se a operação anterior deve ser limpo 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

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 limpo 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

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

Nome Tipo Description
createdAt

string

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

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

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 deve limpo operação anterior 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

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 limpo 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

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

A solução de VNet para o vinculador

Nome Tipo Description
deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Indica se a operação anterior deve ser limpo quando o Vinculador estiver atualizando ou excluindo

type

vNetSolutionType

Tipo de solução de VNet.

vNetSolutionType

Tipo de solução de VNet.

Nome Tipo Description
privateLink

string

serviceEndpoint

string