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 |
|---|---|---|---|---|
|
linker
|
path | True |
string |
Namnet Linker-resurs. |
|
resource
|
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 |
Programklienttypen |
|
| properties.configurationInfo |
Anslutningsinformationen som används av program, inklusive hemligheter, anslutningssträngar. |
|
| properties.publicNetworkSolution |
Nätverkslösningen. |
|
| properties.scope |
string |
anslutningsomfång i källtjänsten. |
| properties.secretStore |
Ett alternativ för att lagra hemligt värde på en säker plats |
|
| properties.targetService | TargetServiceBase: |
Måltjänstegenskaperna |
| properties.vNetSolution |
VNet-lösningen. |
Svar
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Framgångsrik. |
|
| 201 Created |
Tidskrävande åtgärd. |
|
| Other Status Codes |
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 |
|---|---|
|
Access |
Åtkomstnyckeln direkt från målresursegenskaperna, vilken måltjänst som är Azure-resurs, till exempel Microsoft.Storage |
|
access |
Behörigheter för accessKey.
|
|
action |
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. |
|
allow |
Tillåt Att Azure-tjänster får åtkomst till måltjänsten om den är sann. |
|
Auth |
Autentiseringstypen. |
|
Azure |
Resursegenskaperna när typen är Azure Key Vault |
|
Azure |
Azure-resursinformationen när måltjänsttypen är AzureResource |
|
client |
Programklienttypen |
|
Configuration |
Konfigurationsinformationen som används för att generera konfigurationer eller spara till program |
|
Confluent |
Tjänstegenskaperna när måltjänsttypen är ConfluentBootstrapServer |
|
Confluent |
Tjänstegenskaperna när måltjänsttypen är ConfluentSchemaRegistry |
|
created |
Den typ av identitet som skapade resursen. |
|
Dapr |
Dapr-komponentens metadata. |
|
Dapr |
Anger några ytterligare egenskaper för dapr-klienttyp |
|
Delete |
Rensningsbeteendet för att ange om rensningsåtgärden när resursen tas bort eller uppdateras |
|
Error |
Ytterligare information om resurshanteringsfelet. |
|
Error |
Felinformationen. |
|
Error |
Felsvar |
|
Firewall |
Måltjänstens brandväggsregler. för att tillåta anslutningar från källtjänsten. |
|
Key |
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. |
|
Key |
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. |
|
Linker |
Länkare för käll- och målresurs |
|
Public |
Anger lösning för offentligt nätverk, inkludera brandväggsregler |
|
Secret |
Autentiseringsinformationen när authType är hemlig |
|
Secret |
Ett alternativ för att lagra hemligt värde på en säker plats |
|
Secret |
Den hemliga typen. |
|
Self |
Tjänstegenskaperna när måltjänsttypen är SelfHostedServer |
|
Service |
Autentiseringsinformationen när authType är servicePrincipal-certifikat |
|
Service |
Autentiseringsinformationen när authType är servicePrincipal-hemlighet |
|
System |
Autentiseringsinformationen när authType är systemAssignedIdentity |
|
system |
Metadata som rör skapande och senaste ändring av resursen. |
|
User |
Autentiseringsinformationen när authType är användarkonto |
|
User |
Autentiseringsinformationen när authType är userAssignedIdentity |
|
Value |
Den hemliga informationen när typen är rawValue. Det är för scenarier som användaren anger hemligheten. |
|
VNet |
VNet-lösningen för linker |
|
v |
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:
access |
Autentiseringstypen. |
| permissions |
Behörigheter för accessKey.
|
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:
Key |
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: |
Azure-resursanslutningsrelaterade egenskaper. |
| type | string: |
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 |
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 |
Anger några ytterligare egenskaper för dapr-klienttyp |
|
| 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: |
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: |
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 |
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 |
Ytterligare information om felet. |
|
| code |
string |
Felkoden. |
| details |
Felinformationen. |
|
| message |
string |
Felmeddelandet. |
| target |
string |
Felmålet. |
ErrorResponse
Felsvar
| Name | Typ | Description |
|---|---|---|
| error |
Felobjektet. |
FirewallRules
Måltjänstens brandväggsregler. för att tillåta anslutningar från källtjänsten.
| Name | Typ | Description |
|---|---|---|
| azureServices |
Tillåt Att Azure-tjänster får åtkomst till måltjänsten om den är sann. |
|
| callerClientIP |
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:
key |
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:
key |
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 |
Programklienttypen |
|
| properties.configurationInfo |
Anslutningsinformationen som används av program, inklusive hemligheter, anslutningssträngar. |
|
| properties.provisioningState |
string |
Etableringstillståndet. |
| properties.publicNetworkSolution |
Nätverkslösningen. |
|
| properties.scope |
string |
anslutningsomfång i källtjänsten. |
| properties.secretStore |
Ett alternativ för att lagra hemligt värde på en säker plats |
|
| properties.targetService | TargetServiceBase: |
Måltjänstegenskaperna |
| properties.vNetSolution |
VNet-lösningen. |
|
| 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 |
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 |
Anger om du vill rensa föregående åtgärd (till exempel brandväggsregler) när Linker uppdaterar eller tar bort |
|
| 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: |
Måltjänsttypen. |
ServicePrincipalCertificateAuthInfo
Autentiseringsinformationen när authType är servicePrincipal-certifikat
| Name | Typ | Description |
|---|---|---|
| authType |
string:
service |
Autentiseringstypen. |
| certificate |
string |
ServicePrincipal-certifikat för servicePrincipal-autentisering. |
| clientId |
string |
Application clientId för servicePrincipal-autentisering. |
| 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:
service |
Autentiseringstypen. |
| clientId |
string |
ServicePrincipal-programklientId för servicePrincipal-autentisering. |
| 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:
system |
Autentiseringstypen. |
| 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 |
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 |
Den typ av identitet som senast ändrade resursen. |
UserAccountAuthInfo
Autentiseringsinformationen när authType är användarkonto
| Name | Typ | Description |
|---|---|---|
| authType |
string:
user |
Autentiseringstypen. |
| 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:
user |
Autentiseringstypen. |
| clientId |
string |
Klient-ID för userAssignedIdentity. |
| 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:
raw |
Den hemliga typen. |
| value |
string |
Hemlighetens faktiska värde. |
VNetSolution
VNet-lösningen för linker
| Name | Typ | Description |
|---|---|---|
| deleteOrUpdateBehavior |
Anger om du vill rensa föregående åtgärd när Linker uppdaterar eller tar bort |
|
| type |
Typ av VNet-lösning. |
vNetSolutionType
Typ av VNet-lösning.
| Värde | Description |
|---|---|
| serviceEndpoint | |
| privateLink |