Dela via


Linker - Create Or Update

Skapa eller uppdatera Linker-resursen.

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

URI-parametrar

Name I Obligatorisk Typ Description
linkerName
path True

string

Namnet Linker-resurs.

resourceUri
path True

string

Den fullständigt kvalificerade Azure Resource Manager-identifieraren för den resurs som ska anslutas.

api-version
query True

string

minLength: 1

DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name Typ Description
properties.authInfo AuthInfoBase:

Autentiseringstypen.

properties.clientType

clientType

Programklienttypen

properties.configurationInfo

ConfigurationInfo

Anslutningsinformationen som används av program, inklusive hemligheter, anslutningssträngar.

properties.publicNetworkSolution

PublicNetworkSolution

Nätverkslösningen.

properties.scope

string

anslutningsomfång i källtjänsten.

properties.secretStore

SecretStore

Ett alternativ för att lagra hemligt värde på en säker plats

properties.targetService TargetServiceBase:

Måltjänstegenskaperna

properties.vNetSolution

VNetSolution

VNet-lösningen.

Svar

Name Typ Description
200 OK

LinkerResource

Framgångsrik.

201 Created

LinkerResource

Tidskrävande åtgärd.

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

PutLinker

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
AccessKeyInfoBase

Åtkomstnyckeln direkt från målresursegenskaperna, vilken måltjänst som är Azure-resurs, till exempel Microsoft.Storage

accessKeyPermissions

Behörigheter för accessKey. Read och Write gäller för Azure Cosmos DB och Azure App Configuration är Listen, Send och Manage för Azure Event Hub och Azure Service Bus.

actionType

Valfritt. Anger en lösning för offentligt nätverk. Om du aktiverar aktiverar du åtkomst till det offentliga nätverket för måltjänsten med bästa möjliga försök. Standardinställningen är aktiverad. Om du väljer Bort avregistrerar du konfigurationen för offentlig nätverksåtkomst.

allowType

Tillåt Att Azure-tjänster får åtkomst till måltjänsten om den är sann.

AuthType

Autentiseringstypen.

AzureKeyVaultProperties

Resursegenskaperna när typen är Azure Key Vault

AzureResource

Azure-resursinformationen när måltjänsttypen är AzureResource

clientType

Programklienttypen

ConfigurationInfo

Konfigurationsinformationen som används för att generera konfigurationer eller spara till program

ConfluentBootstrapServer

Tjänstegenskaperna när måltjänsttypen är ConfluentBootstrapServer

ConfluentSchemaRegistry

Tjänstegenskaperna när måltjänsttypen är ConfluentSchemaRegistry

createdByType

Den typ av identitet som skapade resursen.

DaprMetadata

Dapr-komponentens metadata.

DaprProperties

Anger några ytterligare egenskaper för dapr-klienttyp

DeleteOrUpdateBehavior

Rensningsbeteendet för att ange om rensningsåtgärden när resursen tas bort eller uppdateras

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

FirewallRules

Måltjänstens brandväggsregler. för att tillåta anslutningar från källtjänsten.

KeyVaultSecretReferenceSecretInfo

Den hemliga informationen när typen är keyVaultSecretReference. Det är för scenariot att användaren tillhandahåller en hemlighet som lagras i användarens nyckelvalv och källan är Azure Kubernetes. Nyckelvalvets resurs-ID är länkat till secretStore.keyVaultId.

KeyVaultSecretUriSecretInfo

Den hemliga informationen när typen är keyVaultSecretUri. Det är för scenariot att användaren tillhandahåller en hemlighet som lagras i användarens nyckelvalv och källan är Webbapp, Spring Cloud eller Container App.

LinkerResource

Länkare för käll- och målresurs

PublicNetworkSolution

Anger lösning för offentligt nätverk, inkludera brandväggsregler

SecretAuthInfo

Autentiseringsinformationen när authType är hemlig

SecretStore

Ett alternativ för att lagra hemligt värde på en säker plats

SecretType

Den hemliga typen.

SelfHostedServer

Tjänstegenskaperna när måltjänsttypen är SelfHostedServer

ServicePrincipalCertificateAuthInfo

Autentiseringsinformationen när authType är servicePrincipal-certifikat

ServicePrincipalSecretAuthInfo

Autentiseringsinformationen när authType är servicePrincipal-hemlighet

SystemAssignedIdentityAuthInfo

Autentiseringsinformationen när authType är systemAssignedIdentity

systemData

Metadata som rör skapande och senaste ändring av resursen.

UserAccountAuthInfo

Autentiseringsinformationen när authType är användarkonto

UserAssignedIdentityAuthInfo

Autentiseringsinformationen när authType är userAssignedIdentity

ValueSecretInfo

Den hemliga informationen när typen är rawValue. Det är för scenarier som användaren anger hemligheten.

VNetSolution

VNet-lösningen för linker

vNetSolutionType

Typ av VNet-lösning.

AccessKeyInfoBase

Åtkomstnyckeln direkt från målresursegenskaperna, vilken måltjänst som är Azure-resurs, till exempel Microsoft.Storage

Name Typ Description
authType string:

accessKey

Autentiseringstypen.

permissions

accessKeyPermissions[]

Behörigheter för accessKey. Read och Write gäller för Azure Cosmos DB och Azure App Configuration är Listen, Send och Manage för Azure Event Hub och Azure Service Bus.

accessKeyPermissions

Behörigheter för accessKey. Read och Write gäller för Azure Cosmos DB och Azure App Configuration är Listen, Send och Manage för Azure Event Hub och Azure Service Bus.

Värde Description
Read
Write
Listen
Send
Manage

actionType

Valfritt. Anger en lösning för offentligt nätverk. Om du aktiverar aktiverar du åtkomst till det offentliga nätverket för måltjänsten med bästa möjliga försök. Standardinställningen är aktiverad. Om du väljer Bort avregistrerar du konfigurationen för offentlig nätverksåtkomst.

Värde Description
enable
optOut

allowType

Tillåt Att Azure-tjänster får åtkomst till måltjänsten om den är sann.

Värde Description
true
false

AuthType

Autentiseringstypen.

Värde Description
systemAssignedIdentity
userAssignedIdentity
servicePrincipalSecret
servicePrincipalCertificate
secret
accessKey
userAccount

AzureKeyVaultProperties

Resursegenskaperna när typen är Azure Key Vault

Name Typ Description
connectAsKubernetesCsiDriver

boolean

Sant om du ansluter via Kubernetes CSI-drivrutin.

type string:

KeyVault

Resurstypen azure.

AzureResource

Azure-resursinformationen när måltjänsttypen är AzureResource

Name Typ Description
id

string

ID:t för Azure-resursen.

resourceProperties AzureResourcePropertiesBase:

AzureKeyVaultProperties

Azure-resursanslutningsrelaterade egenskaper.

type string:

AzureResource

Måltjänsttypen.

clientType

Programklienttypen

Värde Description
none
dotnet
java
python
go
php
ruby
django
nodejs
springBoot
kafka-springBoot
dapr

ConfigurationInfo

Konfigurationsinformationen som används för att generera konfigurationer eller spara till program

Name Typ Description
action

actionType

Valfritt, ange om du vill tillämpa konfigurationer på källprogrammet. Om du aktiverar genererar du konfigurationer och tillämpas på källprogrammet. Standardinställningen är aktiverad. Om optOut görs ingen konfigurationsändring på källan.

additionalConfigurations

object

En ordlista med ytterligare konfigurationer som ska läggas till. Tjänsten genererar automatiskt en uppsättning grundläggande konfigurationer och den här egenskapen är att fylla i fler anpassade konfigurationer

customizedKeys

object

Valfritt. En ordlista med standardnyckelnamn och anpassad nyckelnamnsmappning. Om det inte anges används standardnyckelnamnet för att generera konfigurationer

daprProperties

DaprProperties

Anger några ytterligare egenskaper för dapr-klienttyp

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Anger om du vill rensa föregående åtgärd när Linker uppdaterar eller tar bort

ConfluentBootstrapServer

Tjänstegenskaperna när måltjänsttypen är ConfluentBootstrapServer

Name Typ Description
endpoint

string

Slutpunkten för tjänsten.

type string:

ConfluentBootstrapServer

Måltjänsttypen.

ConfluentSchemaRegistry

Tjänstegenskaperna när måltjänsttypen är ConfluentSchemaRegistry

Name Typ Description
endpoint

string

Slutpunkten för tjänsten.

type string:

ConfluentSchemaRegistry

Måltjänsttypen.

createdByType

Den typ av identitet som skapade resursen.

Värde Description
User
Application
ManagedIdentity
Key

DaprMetadata

Dapr-komponentens metadata.

Name Typ Description
name

string

Namn på metadataegenskap.

secretRef

string

Det hemliga namnet där dapr kan hämta värde

value

string

Egenskapsvärde för metadata.

DaprProperties

Anger några ytterligare egenskaper för dapr-klienttyp

Name Typ Description
componentType

string

Komponenttypen dapr

metadata

DaprMetadata[]

Ytterligare dapr-metadata

scopes

string[]

Dapr-komponentomfattningarna

secretStoreComponent

string

Namnet på en hemlig butiks-dapr för att hämta hemligheten

version

string

Dapr-komponentversionen

DeleteOrUpdateBehavior

Rensningsbeteendet för att ange om rensningsåtgärden när resursen tas bort eller uppdateras

Värde Description
Default
ForcedCleanup

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.

type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

FirewallRules

Måltjänstens brandväggsregler. för att tillåta anslutningar från källtjänsten.

Name Typ Description
azureServices

allowType

Tillåt Att Azure-tjänster får åtkomst till måltjänsten om den är sann.

callerClientIP

allowType

Tillåt anroparens klient-IP att komma åt måltjänsten om den är sann. egenskapen används när du ansluter det lokala programmet till måltjänsten.

ipRanges

string[]

Det här värdet anger den uppsättning IP-adresser eller IP-adressintervall i CIDR-formulär som ska inkluderas som den tillåtna listan över klient-IP-adresser för ett visst databaskonto.

KeyVaultSecretReferenceSecretInfo

Den hemliga informationen när typen är keyVaultSecretReference. Det är för scenariot att användaren tillhandahåller en hemlighet som lagras i användarens nyckelvalv och källan är Azure Kubernetes. Nyckelvalvets resurs-ID är länkat till secretStore.keyVaultId.

Name Typ Description
name

string

Namnet på Key Vault-hemligheten.

secretType string:

keyVaultSecretReference

Den hemliga typen.

version

string

Version av Key Vault-hemligheten.

KeyVaultSecretUriSecretInfo

Den hemliga informationen när typen är keyVaultSecretUri. Det är för scenariot att användaren tillhandahåller en hemlighet som lagras i användarens nyckelvalv och källan är Webbapp, Spring Cloud eller Container App.

Name Typ Description
secretType string:

keyVaultSecretUri

Den hemliga typen.

value

string

URI till keyvault-hemligheten

LinkerResource

Länkare för käll- och målresurs

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Namnet på resursen

properties.authInfo AuthInfoBase:

Autentiseringstypen.

properties.clientType

clientType

Programklienttypen

properties.configurationInfo

ConfigurationInfo

Anslutningsinformationen som används av program, inklusive hemligheter, anslutningssträngar.

properties.provisioningState

string

Etableringstillståndet.

properties.publicNetworkSolution

PublicNetworkSolution

Nätverkslösningen.

properties.scope

string

anslutningsomfång i källtjänsten.

properties.secretStore

SecretStore

Ett alternativ för att lagra hemligt värde på en säker plats

properties.targetService TargetServiceBase:

Måltjänstegenskaperna

properties.vNetSolution

VNetSolution

VNet-lösningen.

systemData

systemData

Systemdata.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

PublicNetworkSolution

Anger lösning för offentligt nätverk, inkludera brandväggsregler

Name Typ Description
action

actionType

Valfritt. Anger en lösning för offentligt nätverk. Om du aktiverar aktiverar du åtkomst till det offentliga nätverket för måltjänsten med bästa möjliga försök. Standardinställningen är aktiverad. Om du väljer Bort avregistrerar du konfigurationen för offentlig nätverksåtkomst.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Anger om du vill rensa föregående åtgärd (till exempel brandväggsregler) när Linker uppdaterar eller tar bort

firewallRules

FirewallRules

Beskriv brandväggsregler för måltjänsten för att se till att källprogrammet kan ansluta till målet.

SecretAuthInfo

Autentiseringsinformationen när authType är hemlig

Name Typ Description
authType string:

secret

Autentiseringstypen.

name

string

Användarnamn eller kontonamn för hemlig autentisering.

secretInfo SecretInfoBase:

Lösenords- eller nyckelvalvshemlighet för hemlig autentisering.

SecretStore

Ett alternativ för att lagra hemligt värde på en säker plats

Name Typ Description
keyVaultId

string

Nyckelvalvs-ID:t för lagring av hemlighet

keyVaultSecretName

string

Nyckelvalvets hemliga namn för lagring av hemlighet, endast giltigt när en hemlighet lagras

SecretType

Den hemliga typen.

Värde Description
rawValue
keyVaultSecretUri
keyVaultSecretReference

SelfHostedServer

Tjänstegenskaperna när måltjänsttypen är SelfHostedServer

Name Typ Description
endpoint

string

Slutpunkten för tjänsten.

type string:

SelfHostedServer

Måltjänsttypen.

ServicePrincipalCertificateAuthInfo

Autentiseringsinformationen när authType är servicePrincipal-certifikat

Name Typ Description
authType string:

servicePrincipalCertificate

Autentiseringstypen.

certificate

string

ServicePrincipal-certifikat för servicePrincipal-autentisering.

clientId

string

Application clientId för servicePrincipal-autentisering.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Anger om du vill rensa föregående åtgärd när Linker uppdaterar eller tar bort

principalId

string

Huvudnamns-ID för servicePrincipal-autentisering.

roles

string[]

Det här värdet är valfritt och anger vilka Azure-roller som ska tilldelas. Automatiskt

ServicePrincipalSecretAuthInfo

Autentiseringsinformationen när authType är servicePrincipal-hemlighet

Name Typ Description
authType string:

servicePrincipalSecret

Autentiseringstypen.

clientId

string

ServicePrincipal-programklientId för servicePrincipal-autentisering.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Anger om du vill rensa föregående åtgärd när Linker uppdaterar eller tar bort

principalId

string

Huvudnamns-ID för servicePrincipal-autentisering.

roles

string[]

Det här värdet är valfritt och anger vilka Azure-roller som ska tilldelas. Automatiskt

secret

string

Hemlighet för servicePrincipal-autentisering.

userName

string

Användarnamn som skapats i databasen som mappas till en användare i AAD.

SystemAssignedIdentityAuthInfo

Autentiseringsinformationen när authType är systemAssignedIdentity

Name Typ Description
authType string:

systemAssignedIdentity

Autentiseringstypen.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Anger om du vill rensa föregående åtgärd när Linker uppdaterar eller tar bort

roles

string[]

Valfritt, det här värdet anger den Azure-roll som ska tilldelas

userName

string

Användarnamn som skapats i databasen som mappas till en användare i AAD.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string (date-time)

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string (date-time)

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.

UserAccountAuthInfo

Autentiseringsinformationen när authType är användarkonto

Name Typ Description
authType string:

userAccount

Autentiseringstypen.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Anger om du vill rensa föregående åtgärd när Linker uppdaterar eller tar bort

principalId

string

Huvudnamns-ID för användarkonto.

roles

string[]

Det här värdet är valfritt och anger vilka Azure-roller som ska tilldelas. Automatiskt

userName

string

Användarnamn som skapats i databasen som mappas till en användare i AAD.

UserAssignedIdentityAuthInfo

Autentiseringsinformationen när authType är userAssignedIdentity

Name Typ Description
authType string:

userAssignedIdentity

Autentiseringstypen.

clientId

string

Klient-ID för userAssignedIdentity.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Anger om du vill rensa föregående åtgärd när Linker uppdaterar eller tar bort

roles

string[]

Valfritt, det här värdet anger den Azure-roll som ska tilldelas

subscriptionId

string

Prenumerations-ID för userAssignedIdentity.

userName

string

Användarnamn som skapats i databasen som mappas till en användare i AAD.

ValueSecretInfo

Den hemliga informationen när typen är rawValue. Det är för scenarier som användaren anger hemligheten.

Name Typ Description
secretType string:

rawValue

Den hemliga typen.

value

string

Hemlighetens faktiska värde.

VNetSolution

VNet-lösningen för linker

Name Typ Description
deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Anger om du vill rensa föregående åtgärd när Linker uppdaterar eller tar bort

type

vNetSolutionType

Typ av VNet-lösning.

vNetSolutionType

Typ av VNet-lösning.

Värde Description
serviceEndpoint
privateLink