Linker - Create Or Update

Vytvořte nebo aktualizujte prostředek linkeru.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
linkerName
path True

string

Název prostředku linkeru.

resourceUri
path True

string

Plně kvalifikovaný identifikátor Azure Resource Manageru prostředku, který se má připojit.

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name Typ Description
properties.authInfo AuthInfoBase:

Typ ověřování.

properties.clientType

clientType

Typ klienta aplikace

properties.configurationInfo

ConfigurationInfo

Informace o připojení využívané aplikacemi, včetně tajných kódů a připojovacích řetězců.

properties.publicNetworkSolution

PublicNetworkSolution

Síťové řešení.

properties.scope

string

obor připojení ve zdrojové službě.

properties.secretStore

SecretStore

Možnost uložení hodnoty tajného kódu na bezpečném místě

properties.targetService TargetServiceBase:

Vlastnosti cílové služby

properties.vNetSolution

VNetSolution

Řešení virtuální sítě.

Odpovědi

Name Typ Description
200 OK

LinkerResource

Úspěšné.

201 Created

LinkerResource

Dlouhotrvající operace.

Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

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

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

PutLinker

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

Sample Response

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

Definice

Name Description
AccessKeyInfoBase

Přístupový klíč přímo z vlastností cílového prostředku, což je cílová služba Prostředek Azure, například Microsoft.Storage

accessKeyPermissions

Oprávnění accessKey. Reada Write jsou pro Azure Cosmos DB a Azure App Configuration Listena SendManage jsou pro centrum událostí Azure a Azure Service Bus.

actionType

Nepovinný parametr. Označuje řešení veřejné sítě. Pokud povolení povolíte, s nejlepším pokusem povolte přístup k cílové službě z veřejné sítě. Výchozí hodnota je povolit. Pokud se rozhodnete, odhlaste konfiguraci přístupu z veřejné sítě.

allowType

Povolte službám Azure přístup k cílové službě, pokud je hodnota true.

AuthType

Typ ověřování.

AzureKeyVaultProperties

Vlastnosti prostředku, pokud je typem Azure Key Vault

AzureResource

Informace o prostředku Azure, pokud je typ cílové služby AzureResource

clientType

Typ klienta aplikace

ConfigurationInfo

Informace o konfiguraci, které se používají ke generování konfigurací nebo ukládání do aplikací

ConfluentBootstrapServer

Vlastnosti služby, pokud je cílový typ služby ConfluentBootstrapServer

ConfluentSchemaRegistry

Vlastnosti služby, pokud je typ cílové služby ConfluentSchemaRegistry

createdByType

Typ identity, která prostředek vytvořila.

DaprMetadata

Metadata komponenty dapr.

DaprProperties

Označuje některé další vlastnosti pro typ klienta dapr.

DeleteOrUpdateBehavior

Chování čištění, které označuje, jestli se operace čištění při odstranění nebo aktualizaci prostředku

ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorDetail

Podrobnosti o chybě

ErrorResponse

Chybová odpověď

FirewallRules

Pravidla brány firewall cílové služby povolte připojení ze zdrojové služby.

KeyVaultSecretReferenceSecretInfo

Informace o tajném kódu, pokud je typ keyVaultSecretReference. Je to pro scénář, kdy uživatel poskytne tajný kód uložený v trezoru klíčů uživatele a zdrojem je Azure Kubernetes. ID prostředku trezoru klíčů je propojené s secretStore.keyVaultId.

KeyVaultSecretUriSecretInfo

Informace o tajném kódu, pokud je typ keyVaultSecretUri. Je to pro scénář, kdy uživatel poskytne tajný kód uložený v trezoru klíčů uživatele a zdrojem je webová aplikace, Spring Cloud nebo aplikace kontejneru.

LinkerResource

Linker zdrojového a cílového prostředku

PublicNetworkSolution

Označuje řešení veřejné sítě, zahrnutí pravidel brány firewall.

SecretAuthInfo

Ověřovací informace, když je authType tajný kód

SecretStore

Možnost uložení hodnoty tajného kódu na bezpečném místě

SecretType

Typ tajného kódu.

SelfHostedServer

Vlastnosti služby, pokud je typ cílové služby SelfHostedServer

ServicePrincipalCertificateAuthInfo

Ověřovací informace, pokud je authType certifikát servicePrincipal

ServicePrincipalSecretAuthInfo

Ověřovací informace, když je authType tajný klíč servicePrincipal

SystemAssignedIdentityAuthInfo

Ověřovací informace, když je authType systemAssignedIdentity

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

UserAccountAuthInfo

Ověřovací informace, když je authType uživatelský účet

UserAssignedIdentityAuthInfo

Ověřovací informace, když je authType userAssignedIdentity

ValueSecretInfo

Informace o tajném kódu, pokud je typ rawValue. Je to pro scénáře, kdy uživatel zadá tajný kód.

VNetSolution

Řešení virtuální sítě pro linker

vNetSolutionType

Typ řešení virtuální sítě

AccessKeyInfoBase

Přístupový klíč přímo z vlastností cílového prostředku, což je cílová služba Prostředek Azure, například Microsoft.Storage

Name Typ Description
authType string:

accessKey

Typ ověřování.

permissions

accessKeyPermissions[]

Oprávnění accessKey. Reada Write jsou pro Azure Cosmos DB a Azure App Configuration Listena SendManage jsou pro centrum událostí Azure a Azure Service Bus.

accessKeyPermissions

Oprávnění accessKey. Reada Write jsou pro Azure Cosmos DB a Azure App Configuration Listena SendManage jsou pro centrum událostí Azure a Azure Service Bus.

Name Typ Description
Listen

string

Manage

string

Read

string

Send

string

Write

string

actionType

Nepovinný parametr. Označuje řešení veřejné sítě. Pokud povolení povolíte, s nejlepším pokusem povolte přístup k cílové službě z veřejné sítě. Výchozí hodnota je povolit. Pokud se rozhodnete, odhlaste konfiguraci přístupu z veřejné sítě.

Name Typ Description
enable

string

optOut

string

allowType

Povolte službám Azure přístup k cílové službě, pokud je hodnota true.

Name Typ Description
false

string

true

string

AuthType

Typ ověřování.

Name Typ Description
accessKey

string

secret

string

servicePrincipalCertificate

string

servicePrincipalSecret

string

systemAssignedIdentity

string

userAccount

string

userAssignedIdentity

string

AzureKeyVaultProperties

Vlastnosti prostředku, pokud je typem Azure Key Vault

Name Typ Description
connectAsKubernetesCsiDriver

boolean

Hodnota True, pokud se připojujete přes ovladač Kubernetes CSI.

type string:

KeyVault

Typ prostředku Azure.

AzureResource

Informace o prostředku Azure, pokud je typ cílové služby AzureResource

Name Typ Description
id

string

ID prostředku Azure.

resourceProperties AzureResourcePropertiesBase:

AzureKeyVaultProperties

Vlastnosti související s připojením prostředků Azure.

type string:

AzureResource

Typ cílové služby.

clientType

Typ klienta aplikace

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

Informace o konfiguraci, které se používají ke generování konfigurací nebo ukládání do aplikací

Name Typ Description
action

actionType

Volitelné– označuje, jestli se mají použít konfigurace u zdrojové aplikace. Pokud povolíte, vygenerujte konfigurace a aplikujte je na zdrojovou aplikaci. Výchozí hodnota je povolit. V případě optOut se ve zdroji neprovedou žádné změny konfigurace.

additionalConfigurations

object

Slovník dalších konfigurací, které se mají přidat. Služba automaticky vygeneruje sadu základních konfigurací a tato vlastnost má plně vyplnit více přizpůsobených konfigurací.

customizedKeys

object

Nepovinný parametr. Slovník výchozího názvu klíče a vlastního mapování názvů klíčů. Pokud není zadaný, použije se pro generování konfigurací výchozí název klíče.

daprProperties

DaprProperties

Označuje některé další vlastnosti pro typ klienta dapr.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Určuje, jestli se má vyčistit předchozí operace, když linker aktualizuje nebo odstraňuje.

ConfluentBootstrapServer

Vlastnosti služby, pokud je cílový typ služby ConfluentBootstrapServer

Name Typ Description
endpoint

string

Koncový bod služby.

type string:

ConfluentBootstrapServer

Typ cílové služby.

ConfluentSchemaRegistry

Vlastnosti služby, pokud je typ cílové služby ConfluentSchemaRegistry

Name Typ Description
endpoint

string

Koncový bod služby.

type string:

ConfluentSchemaRegistry

Typ cílové služby.

createdByType

Typ identity, která prostředek vytvořila.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

DaprMetadata

Metadata komponenty dapr.

Name Typ Description
name

string

Název vlastnosti metadat.

secretRef

string

Název tajného kódu, kde dapr může získat hodnotu

value

string

Hodnota vlastnosti metadat.

DaprProperties

Označuje některé další vlastnosti pro typ klienta dapr.

Name Typ Description
componentType

string

Typ komponenty dapr

metadata

DaprMetadata[]

Další metadata dapr

scopes

string[]

Obory komponent dapr

secretStoreComponent

string

Název úložiště tajných kódů dapr pro načtení tajného kódu

version

string

Verze komponenty dapr

DeleteOrUpdateBehavior

Chování čištění, které označuje, jestli se operace čištění při odstranění nebo aktualizaci prostředku

Name Typ Description
Default

string

ForcedCleanup

string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.

type

string

Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.

code

string

Kód chyby

details

ErrorDetail[]

Podrobnosti o chybě.

message

string

Chybová zpráva

target

string

Cíl chyby.

ErrorResponse

Chybová odpověď

Name Typ Description
error

ErrorDetail

Objekt chyby.

FirewallRules

Pravidla brány firewall cílové služby povolte připojení ze zdrojové služby.

Name Typ Description
azureServices

allowType

Povolte službám Azure přístup k cílové službě, pokud je hodnota true.

callerClientIP

allowType

Povolte IP adresu klienta volajícího pro přístup k cílové službě, pokud je hodnota true. vlastnost se používá při připojování místní aplikace k cílové službě.

ipRanges

string[]

Tato hodnota určuje sadu IP adres nebo rozsahů IP adres ve formuláři CIDR, která se má zahrnout jako seznam povolených IP adres klientů pro daný databázový účet.

KeyVaultSecretReferenceSecretInfo

Informace o tajném kódu, pokud je typ keyVaultSecretReference. Je to pro scénář, kdy uživatel poskytne tajný kód uložený v trezoru klíčů uživatele a zdrojem je Azure Kubernetes. ID prostředku trezoru klíčů je propojené s secretStore.keyVaultId.

Name Typ Description
name

string

Název tajného kódu Key Vault.

secretType string:

keyVaultSecretReference

Typ tajného kódu.

version

string

Verze tajného kódu Key Vault.

KeyVaultSecretUriSecretInfo

Informace o tajném kódu, pokud je typ keyVaultSecretUri. Je to pro scénář, kdy uživatel poskytne tajný kód uložený v trezoru klíčů uživatele a zdrojem je webová aplikace, Spring Cloud nebo aplikace kontejneru.

Name Typ Description
secretType string:

keyVaultSecretUri

Typ tajného kódu.

value

string

Identifikátor URI tajného klíče trezoru klíčů

LinkerResource

Linker zdrojového a cílového prostředku

Name Typ Description
id

string

Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}

name

string

Název prostředku

properties.authInfo AuthInfoBase:

Typ ověřování.

properties.clientType

clientType

Typ klienta aplikace

properties.configurationInfo

ConfigurationInfo

Informace o připojení využívané aplikacemi, včetně tajných kódů a připojovacích řetězců.

properties.provisioningState

string

Stav zřizování.

properties.publicNetworkSolution

PublicNetworkSolution

Síťové řešení.

properties.scope

string

obor připojení ve zdrojové službě.

properties.secretStore

SecretStore

Možnost uložení hodnoty tajného kódu na bezpečném místě

properties.targetService TargetServiceBase:

Vlastnosti cílové služby

properties.vNetSolution

VNetSolution

Řešení virtuální sítě.

systemData

systemData

Systémová data.

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

PublicNetworkSolution

Označuje řešení veřejné sítě, zahrnutí pravidel brány firewall.

Name Typ Description
action

actionType

Nepovinný parametr. Označuje řešení veřejné sítě. Pokud povolení povolíte, s nejlepším pokusem povolte přístup k cílové službě z veřejné sítě. Výchozí hodnota je povolit. Pokud se rozhodnete, odhlaste konfiguraci přístupu z veřejné sítě.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Určuje, jestli se má vyčistit předchozí operace (například pravidla brány firewall), když linker aktualizuje nebo odstraňuje.

firewallRules

FirewallRules

Popište pravidla brány firewall cílové služby a ujistěte se, že se zdrojová aplikace může připojit k cíli.

SecretAuthInfo

Ověřovací informace, když je authType tajný kód

Name Typ Description
authType string:

secret

Typ ověřování.

name

string

Uživatelské jméno nebo název účtu pro ověřování tajných kódů

secretInfo SecretInfoBase:

Heslo nebo tajný kód trezoru klíčů pro ověřování tajných kódů.

SecretStore

Možnost uložení hodnoty tajného kódu na bezpečném místě

Name Typ Description
keyVaultId

string

ID trezoru klíčů pro uložení tajného kódu

keyVaultSecretName

string

Název tajného kódu trezoru klíčů pro uložení tajného kódu, který je platný jenom při ukládání jednoho tajného kódu.

SecretType

Typ tajného kódu.

Name Typ Description
keyVaultSecretReference

string

keyVaultSecretUri

string

rawValue

string

SelfHostedServer

Vlastnosti služby, pokud je typ cílové služby SelfHostedServer

Name Typ Description
endpoint

string

Koncový bod služby.

type string:

SelfHostedServer

Typ cílové služby.

ServicePrincipalCertificateAuthInfo

Ověřovací informace, pokud je authType certifikát servicePrincipal

Name Typ Description
authType string:

servicePrincipalCertificate

Typ ověřování.

certificate

string

Certifikát ServicePrincipal pro ověřování servicePrincipal.

clientId

string

Id klienta aplikace pro ověřování servicePrincipal.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Určuje, jestli se má vyčistit předchozí operace, když linker aktualizuje nebo odstraňuje.

principalId

string

ID instančního objektu pro ověřování servicePrincipal.

roles

string[]

Volitelná hodnota určuje role Azure, které se mají přiřadit. Automaticky

ServicePrincipalSecretAuthInfo

Ověřovací informace, když je authType tajný klíč servicePrincipal

Name Typ Description
authType string:

servicePrincipalSecret

Typ ověřování.

clientId

string

Id klienta aplikace ServicePrincipal pro ověřování servicePrincipal.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Určuje, jestli se má vyčistit předchozí operace, když linker aktualizuje nebo odstraňuje.

principalId

string

ID instančního objektu pro ověřování servicePrincipal.

roles

string[]

Volitelná hodnota určuje role Azure, které se mají přiřadit. Automaticky

secret

string

Tajný kód pro ověřování servicePrincipal.

userName

string

Uživatelské jméno vytvořené v databázi, která je mapovaná na uživatele v AAD.

SystemAssignedIdentityAuthInfo

Ověřovací informace, když je authType systemAssignedIdentity

Name Typ Description
authType string:

systemAssignedIdentity

Typ ověřování.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Určuje, jestli se má vyčistit předchozí operace, když linker aktualizuje nebo odstraňuje.

roles

string[]

Volitelné– tato hodnota určuje roli Azure, která se má přiřadit.

userName

string

Uživatelské jméno vytvořené v databázi, která je mapovaná na uživatele v AAD.

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name Typ Description
createdAt

string

Časové razítko vytvoření prostředku (UTC)

createdBy

string

Identita, která vytvořila prostředek.

createdByType

createdByType

Typ identity, která prostředek vytvořila.

lastModifiedAt

string

Časové razítko poslední změny prostředku (UTC)

lastModifiedBy

string

Identita, která naposledy změnila prostředek.

lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.

UserAccountAuthInfo

Ověřovací informace, když je authType uživatelský účet

Name Typ Description
authType string:

userAccount

Typ ověřování.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Určuje, jestli se má vyčistit předchozí operace, když linker aktualizuje nebo odstraňuje.

principalId

string

ID objektu zabezpečení pro uživatelský účet.

roles

string[]

Volitelná hodnota určuje role Azure, které se mají přiřadit. Automaticky

userName

string

Uživatelské jméno vytvořené v databázi, která je mapovaná na uživatele v AAD.

UserAssignedIdentityAuthInfo

Ověřovací informace, když je authType userAssignedIdentity

Name Typ Description
authType string:

userAssignedIdentity

Typ ověřování.

clientId

string

ID klienta pro userAssignedIdentity.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Určuje, jestli se má vyčistit předchozí operace, když linker aktualizuje nebo odstraňuje.

roles

string[]

Volitelné– tato hodnota určuje roli Azure, která se má přiřadit.

subscriptionId

string

ID předplatného pro userAssignedIdentity.

userName

string

Uživatelské jméno vytvořené v databázi, která je mapovaná na uživatele v AAD.

ValueSecretInfo

Informace o tajném kódu, pokud je typ rawValue. Je to pro scénáře, kdy uživatel zadá tajný kód.

Name Typ Description
secretType string:

rawValue

Typ tajného kódu.

value

string

Skutečná hodnota tajného kódu.

VNetSolution

Řešení virtuální sítě pro linker

Name Typ Description
deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Určuje, jestli se má vyčistit předchozí operace, když linker aktualizuje nebo odstraňuje.

type

vNetSolutionType

Typ řešení virtuální sítě

vNetSolutionType

Typ řešení virtuální sítě

Name Typ Description
privateLink

string

serviceEndpoint

string