Delen via


Linker - Create Or Update

Linker-resource maken of bijwerken.

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

URI-parameters

Name In Vereist Type Description
linkerName
path True

string

De naam Linker-resource.

resourceUri
path True

string

De volledig gekwalificeerde Azure Resource Manager-id van de resource die moet worden verbonden.

api-version
query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name Type Description
properties.authInfo AuthInfoBase:

Het verificatietype.

properties.clientType

clientType

Het clienttype van de toepassing

properties.configurationInfo

ConfigurationInfo

De verbindingsgegevens die worden gebruikt door toepassingen, waaronder geheimen en verbindingsreeksen.

properties.publicNetworkSolution

PublicNetworkSolution

De netwerkoplossing.

properties.scope

string

verbindingsbereik in bronservice.

properties.secretStore

SecretStore

Een optie voor het opslaan van geheime waarde op een veilige plaats

properties.targetService TargetServiceBase:

De eigenschappen van de doelservice

properties.vNetSolution

VNetSolution

De VNet-oplossing.

Antwoorden

Name Type Description
200 OK

LinkerResource

Geslaagd.

201 Created

LinkerResource

Langdurige bewerking.

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation uw gebruikersaccount imiteren

Voorbeelden

PutLinker

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
AccessKeyInfoBase

De toegangssleutel rechtstreeks vanuit de eigenschappen van de doelresource, welke doelservice Azure Resource is, zoals Microsoft.Storage

accessKeyPermissions

Machtigingen van de accessKey. Readen Write zijn voor Azure Cosmos DB en Azure App Configuration, Listenen SendManage zijn voor Azure Event Hub en Azure Service Bus.

actionType

Optioneel. Hiermee wordt een openbare netwerkoplossing aangegeven. Als dit is ingeschakeld, schakelt u de openbare netwerktoegang van de doelservice in met de beste poging. De standaardinstelling is ingeschakeld. Als u optOut kiest, kunt u de configuratie van openbare netwerktoegang uitschakelen.

allowType

Azure-services toegang geven tot de doelservice, indien waar.

AuthType

Het verificatietype.

AzureKeyVaultProperties

De resource-eigenschappen wanneer het type Azure Key Vault

AzureResource

De azure-resourcegegevens wanneer het doelservicetype AzureResource is

clientType

Het clienttype van de toepassing

ConfigurationInfo

De configuratiegegevens, die worden gebruikt om configuraties te genereren of op te slaan in toepassingen

ConfluentBootstrapServer

De service-eigenschappen wanneer het doelservicetype ConfluentBootstrapServer is

ConfluentSchemaRegistry

De service-eigenschappen wanneer het doelservicetype ConfluentSchemaRegistry is

createdByType

Het type identiteit waarmee de resource is gemaakt.

DaprMetadata

De metagegevens van het dapr-onderdeel.

DaprProperties

Geeft enkele aanvullende eigenschappen voor dapr-clienttype aan

DeleteOrUpdateBehavior

Het opschoningsgedrag om aan te geven of de opschoonbewerking wordt uitgevoerd wanneer de resource wordt verwijderd of bijgewerkt

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Foutreactie

FirewallRules

De firewallregels van de doelservice. om verbindingen van de bronservice toe te staan.

KeyVaultSecretReferenceSecretInfo

De geheime informatie wanneer het type keyVaultSecretReference is. Het is voor scenario dat de gebruiker een geheim opgeeft dat is opgeslagen in de sleutelkluis van de gebruiker en dat de bron Azure Kubernetes is. De resource-id van de sleutelkluis is gekoppeld aan secretStore.keyVaultId.

KeyVaultSecretUriSecretInfo

De geheime informatie wanneer het type keyVaultSecretUri is. Het is voor scenario dat de gebruiker een geheim opgeeft dat is opgeslagen in de sleutelkluis van de gebruiker en de bron is Web App, Spring Cloud of Container App.

LinkerResource

Koppeling van bron- en doelresource

PublicNetworkSolution

Geeft een openbare netwerkoplossing aan, inclusief firewallregels

SecretAuthInfo

De verificatiegegevens wanneer authType geheim is

SecretStore

Een optie voor het opslaan van geheime waarde op een veilige plaats

SecretType

Het geheime type.

SelfHostedServer

De service-eigenschappen wanneer het doelservicetype SelfHostedServer is

ServicePrincipalCertificateAuthInfo

De verificatiegegevens wanneer authType een servicePrincipal-certificaat is

ServicePrincipalSecretAuthInfo

De verificatiegegevens wanneer authType een servicePrincipal-geheim is

SystemAssignedIdentityAuthInfo

De verificatiegegevens wanneer authType systemAssignedIdentity is

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

UserAccountAuthInfo

De verificatiegegevens wanneer authType een gebruikersaccount is

UserAssignedIdentityAuthInfo

De verificatiegegevens wanneer authType userAssignedIdentity is

ValueSecretInfo

De geheime informatie wanneer het type rawValue is. Het is voor scenario's waarin de gebruiker het geheim invoert.

VNetSolution

De VNet-oplossing voor linker

vNetSolutionType

Type VNet-oplossing.

AccessKeyInfoBase

De toegangssleutel rechtstreeks vanuit de eigenschappen van de doelresource, welke doelservice Azure Resource is, zoals Microsoft.Storage

Name Type Description
authType string:

accessKey

Het verificatietype.

permissions

accessKeyPermissions[]

Machtigingen van de accessKey. Readen Write zijn voor Azure Cosmos DB en Azure App Configuration, Listenen SendManage zijn voor Azure Event Hub en Azure Service Bus.

accessKeyPermissions

Machtigingen van de accessKey. Readen Write zijn voor Azure Cosmos DB en Azure App Configuration, Listenen SendManage zijn voor Azure Event Hub en Azure Service Bus.

Name Type Description
Listen

string

Manage

string

Read

string

Send

string

Write

string

actionType

Optioneel. Hiermee wordt een openbare netwerkoplossing aangegeven. Als dit is ingeschakeld, schakelt u de openbare netwerktoegang van de doelservice in met de beste poging. De standaardinstelling is ingeschakeld. Als u optOut kiest, kunt u de configuratie van openbare netwerktoegang uitschakelen.

Name Type Description
enable

string

optOut

string

allowType

Azure-services toegang geven tot de doelservice, indien waar.

Name Type Description
false

string

true

string

AuthType

Het verificatietype.

Name Type Description
accessKey

string

secret

string

servicePrincipalCertificate

string

servicePrincipalSecret

string

systemAssignedIdentity

string

userAccount

string

userAssignedIdentity

string

AzureKeyVaultProperties

De resource-eigenschappen wanneer het type Azure Key Vault

Name Type Description
connectAsKubernetesCsiDriver

boolean

Waar als u verbinding maakt via het Kubernetes CSI-stuurprogramma.

type string:

KeyVault

Het azure-resourcetype.

AzureResource

De azure-resourcegegevens wanneer het doelservicetype AzureResource is

Name Type Description
id

string

De id van de Azure-resource.

resourceProperties AzureResourcePropertiesBase:

AzureKeyVaultProperties

De eigenschappen van de azure-resourceverbinding.

type string:

AzureResource

Het doelservicetype.

clientType

Het clienttype van de toepassing

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

De configuratiegegevens, die worden gebruikt om configuraties te genereren of op te slaan in toepassingen

Name Type Description
action

actionType

Optioneel, geeft aan of configuraties moeten worden toegepast op de brontoepassing. Als dit is ingeschakeld, genereert u configuraties en wordt deze toegepast op de brontoepassing. De standaardinstelling is ingeschakeld. Als u optOut kiest, wordt er geen configuratiewijziging aangebracht op de bron.

additionalConfigurations

object

Een woordenlijst met aanvullende configuraties die moeten worden toegevoegd. Service genereert automatisch een set basisconfiguraties en deze eigenschap is bedoeld om meer aangepaste configuraties volledig in te vullen

customizedKeys

object

Optioneel. Een woordenlijst met standaardsleutelnaam en aangepaste sleutelnaamtoewijzing. Als dit niet wordt opgegeven, wordt de standaardsleutelnaam gebruikt voor het genereren van configuraties

daprProperties

DaprProperties

Geeft enkele aanvullende eigenschappen voor dapr-clienttype aan

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Geeft aan of de vorige bewerking moet worden opgeschoond wanneer Linker wordt bijgewerkt of verwijderd

ConfluentBootstrapServer

De service-eigenschappen wanneer het doelservicetype ConfluentBootstrapServer is

Name Type Description
endpoint

string

Het eindpunt van de service.

type string:

ConfluentBootstrapServer

Het doelservicetype.

ConfluentSchemaRegistry

De service-eigenschappen wanneer het doelservicetype ConfluentSchemaRegistry is

Name Type Description
endpoint

string

Het eindpunt van de service.

type string:

ConfluentSchemaRegistry

Het doelservicetype.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

DaprMetadata

De metagegevens van het dapr-onderdeel.

Name Type Description
name

string

Naam van metagegevenseigenschap.

secretRef

string

De geheime naam waar dapr waarde kan ophalen

value

string

Waarde van metagegevenseigenschap.

DaprProperties

Geeft enkele aanvullende eigenschappen voor dapr-clienttype aan

Name Type Description
componentType

string

Het dapr-onderdeeltype

metadata

DaprMetadata[]

Aanvullende dapr-metagegevens

scopes

string[]

De dapr-onderdeelbereiken

secretStoreComponent

string

De naam van een geheimarchief dapr om geheim op te halen

version

string

De dapr-onderdeelversie

DeleteOrUpdateBehavior

Het opschoningsgedrag om aan te geven of de opschoonbewerking wordt uitgevoerd wanneer de resource wordt verwijderd of bijgewerkt

Name Type Description
Default

string

ForcedCleanup

string

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.

type

string

Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

Aanvullende informatie over de fout.

code

string

De foutcode.

details

ErrorDetail[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

ErrorResponse

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

FirewallRules

De firewallregels van de doelservice. om verbindingen van de bronservice toe te staan.

Name Type Description
azureServices

allowType

Azure-services toegang geven tot de doelservice, indien waar.

callerClientIP

allowType

Sta het IP-adres van de bellerclient toegang tot de doelservice toe, indien waar. de eigenschap wordt gebruikt bij het verbinden van de lokale toepassing met de doelservice.

ipRanges

string[]

Deze waarde geeft de set IP-adressen of IP-adresbereiken in CIDR-vorm op die moeten worden opgenomen als de lijst met toegestane client-IP-adressen voor een bepaald databaseaccount.

KeyVaultSecretReferenceSecretInfo

De geheime informatie wanneer het type keyVaultSecretReference is. Het is voor scenario dat de gebruiker een geheim opgeeft dat is opgeslagen in de sleutelkluis van de gebruiker en dat de bron Azure Kubernetes is. De resource-id van de sleutelkluis is gekoppeld aan secretStore.keyVaultId.

Name Type Description
name

string

Naam van het Key Vault geheim.

secretType string:

keyVaultSecretReference

Het geheime type.

version

string

Versie van het Key Vault geheim.

KeyVaultSecretUriSecretInfo

De geheime informatie wanneer het type keyVaultSecretUri is. Het is voor scenario dat de gebruiker een geheim opgeeft dat is opgeslagen in de sleutelkluis van de gebruiker en de bron is Web App, Spring Cloud of Container App.

Name Type Description
secretType string:

keyVaultSecretUri

Het geheime type.

value

string

URI naar het sleutelkluisgeheim

LinkerResource

Koppeling van bron- en doelresource

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

De naam van de resource

properties.authInfo AuthInfoBase:

Het verificatietype.

properties.clientType

clientType

Het clienttype van de toepassing

properties.configurationInfo

ConfigurationInfo

De verbindingsgegevens die worden gebruikt door toepassingen, waaronder geheimen en verbindingsreeksen.

properties.provisioningState

string

De inrichtingsstatus.

properties.publicNetworkSolution

PublicNetworkSolution

De netwerkoplossing.

properties.scope

string

verbindingsbereik in bronservice.

properties.secretStore

SecretStore

Een optie voor het opslaan van geheime waarde op een veilige plaats

properties.targetService TargetServiceBase:

De eigenschappen van de doelservice

properties.vNetSolution

VNetSolution

De VNet-oplossing.

systemData

systemData

De systeemgegevens.

type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PublicNetworkSolution

Geeft een openbare netwerkoplossing aan, inclusief firewallregels

Name Type Description
action

actionType

Optioneel. Hiermee wordt een openbare netwerkoplossing aangegeven. Als dit is ingeschakeld, schakelt u de openbare netwerktoegang van de doelservice in met de beste poging. De standaardinstelling is ingeschakeld. Als u optOut kiest, kunt u de configuratie van openbare netwerktoegang uitschakelen.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Geeft aan of de vorige bewerking (zoals firewallregels) moet worden opgeschoond wanneer Linker wordt bijgewerkt of verwijderd

firewallRules

FirewallRules

Beschrijf de firewallregels van de doelservice om ervoor te zorgen dat de brontoepassing verbinding kan maken met het doel.

SecretAuthInfo

De verificatiegegevens wanneer authType geheim is

Name Type Description
authType string:

secret

Het verificatietype.

name

string

Gebruikersnaam of accountnaam voor geheime verificatie.

secretInfo SecretInfoBase:

Wachtwoord- of sleutelkluisgeheim voor verificatie van geheimen.

SecretStore

Een optie voor het opslaan van geheime waarde op een veilige plaats

Name Type Description
keyVaultId

string

De sleutelkluis-id voor het opslaan van het geheim

keyVaultSecretName

string

De naam van het sleutelkluisgeheim voor het opslaan van het geheim, alleen geldig bij het opslaan van één geheim

SecretType

Het geheime type.

Name Type Description
keyVaultSecretReference

string

keyVaultSecretUri

string

rawValue

string

SelfHostedServer

De service-eigenschappen wanneer het doelservicetype SelfHostedServer is

Name Type Description
endpoint

string

Het eindpunt van de service.

type string:

SelfHostedServer

Het doelservicetype.

ServicePrincipalCertificateAuthInfo

De verificatiegegevens wanneer authType een servicePrincipal-certificaat is

Name Type Description
authType string:

servicePrincipalCertificate

Het verificatietype.

certificate

string

ServicePrincipal-certificaat voor servicePrincipal-verificatie.

clientId

string

ClientId van toepassing voor servicePrincipal-verificatie.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Geeft aan of de vorige bewerking moet worden opgeschoond wanneer Linker wordt bijgewerkt of verwijderd

principalId

string

Principal-id voor servicePrincipal-verificatie.

roles

string[]

Optioneel: deze waarde geeft de Azure-rollen aan die moeten worden toegewezen. Automatisch

ServicePrincipalSecretAuthInfo

De verificatiegegevens wanneer authType een servicePrincipal-geheim is

Name Type Description
authType string:

servicePrincipalSecret

Het verificatietype.

clientId

string

ClientId van ServicePrincipal-toepassing voor servicePrincipal-verificatie.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Geeft aan of de vorige bewerking moet worden opgeschoond wanneer Linker wordt bijgewerkt of verwijderd

principalId

string

Principal-id voor servicePrincipal-verificatie.

roles

string[]

Optioneel: deze waarde geeft de Azure-rollen aan die moeten worden toegewezen. Automatisch

secret

string

Geheim voor servicePrincipal-verificatie.

userName

string

Gebruikersnaam gemaakt in de database die is toegewezen aan een gebruiker in AAD.

SystemAssignedIdentityAuthInfo

De verificatiegegevens wanneer authType systemAssignedIdentity is

Name Type Description
authType string:

systemAssignedIdentity

Het verificatietype.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Geeft aan of de vorige bewerking moet worden opgeschoond wanneer Linker wordt bijgewerkt of verwijderd

roles

string[]

Optioneel, deze waarde geeft de Azure-rol aan die moet worden toegewezen

userName

string

Gebruikersnaam gemaakt in de database die is toegewezen aan een gebruiker in AAD.

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name Type Description
createdAt

string

Het tijdstempel van het maken van resources (UTC).

createdBy

string

De identiteit waarmee de resource is gemaakt.

createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.

lastModifiedAt

string

De tijdstempel van de laatste wijziging van de resource (UTC)

lastModifiedBy

string

De identiteit die de resource het laatst heeft gewijzigd.

lastModifiedByType

createdByType

Het type identiteit dat de resource het laatst heeft gewijzigd.

UserAccountAuthInfo

De verificatiegegevens wanneer authType een gebruikersaccount is

Name Type Description
authType string:

userAccount

Het verificatietype.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Geeft aan of de vorige bewerking moet worden opgeschoond wanneer Linker wordt bijgewerkt of verwijderd

principalId

string

Principal-id voor gebruikersaccount.

roles

string[]

Optioneel: deze waarde geeft de Azure-rollen aan die moeten worden toegewezen. Automatisch

userName

string

Gebruikersnaam gemaakt in de database die is toegewezen aan een gebruiker in AAD.

UserAssignedIdentityAuthInfo

De verificatiegegevens wanneer authType userAssignedIdentity is

Name Type Description
authType string:

userAssignedIdentity

Het verificatietype.

clientId

string

Client-id voor userAssignedIdentity.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Geeft aan of de vorige bewerking moet worden opgeschoond wanneer Linker wordt bijgewerkt of verwijderd

roles

string[]

Optioneel, deze waarde geeft de Azure-rol aan die moet worden toegewezen

subscriptionId

string

Abonnements-id voor userAssignedIdentity.

userName

string

Gebruikersnaam gemaakt in de database die is toegewezen aan een gebruiker in AAD.

ValueSecretInfo

De geheime informatie wanneer het type rawValue is. Het is voor scenario's waarin de gebruiker het geheim invoert.

Name Type Description
secretType string:

rawValue

Het geheime type.

value

string

De werkelijke waarde van het geheim.

VNetSolution

De VNet-oplossing voor linker

Name Type Description
deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Geeft aan of de vorige bewerking moet worden opgeschoond wanneer Linker wordt bijgewerkt of verwijderd

type

vNetSolutionType

Type VNet-oplossing.

vNetSolutionType

Type VNet-oplossing.

Name Type Description
privateLink

string

serviceEndpoint

string