Linker - Create Or Update

Criar ou atualizar o recurso do vinculador.

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

Parâmetros de URI

Name In Required Type Description
linkerName
path True
  • string

O recurso vinculador de nome.

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 essa operação.

Corpo da solicitação

Name Type Description
properties.authInfo AuthInfoBase:

O tipo de autenticação.

properties.clientType

O tipo de cliente do aplicativo

properties.secretStore

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

properties.targetId
  • string

A ID do recurso do serviço de destino.

properties.vNetSolution

A solução VNet.

Respostas

Name Type Description
200 OK

Bem sucedido.

201 Created

Operação de execução longa.

Other Status Codes

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

PutLink
PutLinkWithServiceEndpoint

Sample Request

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=2021-11-01-preview

{
  "properties": {
    "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db",
    "authInfo": {
      "authType": "secret",
      "name": "name",
      "secret": "secret"
    }
  }
}

Sample Response

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName",
  "type": "Microsoft.ServiceLinker/links",
  "name": "linkName",
  "properties": {
    "authInfo": {
      "authType": "secret",
      "name": "name"
    },
    "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
  }
}
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName",
  "type": "Microsoft.ServiceLinker/links",
  "name": "linkName",
  "properties": {
    "authInfo": {
      "authType": "secret",
      "name": "name"
    },
    "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
  }
}

PutLinkWithServiceEndpoint

Sample Request

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=2021-11-01-preview

{
  "properties": {
    "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db",
    "authInfo": {
      "authType": "secret",
      "name": "name",
      "secret": "secret"
    },
    "vNetSolution": {
      "type": "serviceEndpoint"
    },
    "secretStore": {
      "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv"
    }
  }
}

Sample Response

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName",
  "type": "Microsoft.ServiceLinker/links",
  "name": "linkName",
  "properties": {
    "authInfo": {
      "authType": "secret",
      "name": "name"
    },
    "vNetSolution": {
      "type": "serviceEndpoint"
    },
    "secretStore": {
      "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv"
    },
    "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
  }
}
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName",
  "type": "Microsoft.ServiceLinker/links",
  "name": "linkName",
  "properties": {
    "authInfo": {
      "authType": "secret",
      "name": "name"
    },
    "vNetSolution": {
      "type": "serviceEndpoint"
    },
    "secretStore": {
      "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv"
    },
    "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
  }
}

Definições

AuthType

O tipo de autenticação.

clientType

O tipo de cliente do aplicativo

createdByType

O tipo de identidade que criou o recurso.

ErrorAdditionalInfo

As informações adicionais sobre o erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

LinkerResource

Vinculador do recurso de origem e de destino

SecretAuthInfo

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

SecretStore

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

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.

UserAssignedIdentityAuthInfo

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

VNetSolution

A solução VNet para o vinculador

vNetSolutionType

Tipo de solução de VNet.

AuthType

O tipo de autenticação.

Name Type Description
secret
  • string
servicePrincipalCertificate
  • string
servicePrincipalSecret
  • string
systemAssignedIdentity
  • string
userAssignedIdentity
  • string

clientType

O tipo de cliente do aplicativo

Name Type Description
django
  • string
dotnet
  • string
go
  • string
java
  • string
nodejs
  • string
none
  • string
php
  • string
python
  • string
ruby
  • string
springBoot
  • string

createdByType

O tipo de identidade que criou o recurso.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorAdditionalInfo

As informações adicionais sobre o erro de gerenciamento de recursos.

Name Type Description
info
  • object

As informações adicionais.

type
  • string

O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name Type Description
additionalInfo

As informações adicionais do erro.

code
  • string

O código de erro.

details

Os detalhes do erro.

message
  • string

A mensagem de erro.

target
  • string

O destino do erro.

ErrorResponse

Resposta de erro

Name Type Description
error

O objeto de erro.

LinkerResource

Vinculador do recurso de origem e de destino

Name Type 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

O tipo de cliente do aplicativo

properties.provisioningState
  • string

O estado de provisionamento.

properties.secretStore

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

properties.targetId
  • string

A ID do recurso do serviço de destino.

properties.vNetSolution

A solução VNet.

systemData

Os dados do sistema.

type
  • string

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

SecretAuthInfo

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

Name Type Description
authType string:
  • secret

O tipo de autenticação.

name
  • string

Nome de usuário ou nome de conta para autenticação secreta.

secret
  • string

Senha ou chave de conta para autenticação secreta.

SecretStore

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

Name Type Description
keyVaultId
  • string

A ID do cofre de chaves para armazenar segredo

ServicePrincipalCertificateAuthInfo

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

Name Type 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.

principalId
  • string

ID da entidade de segurança para autenticação servicePrincipal.

ServicePrincipalSecretAuthInfo

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

Name Type Description
authType string:
  • servicePrincipalSecret

O tipo de autenticação.

clientId
  • string

ClientId do aplicativo ServicePrincipal para auth servicePrincipal.

principalId
  • string

ID da entidade de segurança para autenticação servicePrincipal.

secret
  • string

Segredo para autenticação servicePrincipal.

SystemAssignedIdentityAuthInfo

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

Name Type Description
authType string:
  • systemAssignedIdentity

O tipo de autenticação.

systemData

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

Name Type Description
createdAt
  • string

O carimbo de data/hora da criação de recursos (UTC).

createdBy
  • string

A identidade que criou o recurso.

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

O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentityAuthInfo

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

Name Type Description
authType string:
  • userAssignedIdentity

O tipo de autenticação.

clientId
  • string

ID do cliente para userAssignedIdentity.

subscriptionId
  • string

ID da assinatura para userAssignedIdentity.

VNetSolution

A solução VNet para o vinculador

Name Type Description
type

Tipo de solução de VNet.

vNetSolutionType

Tipo de solução de VNet.

Name Type Description
privateLink
  • string
serviceEndpoint
  • string