Linker - Create Or Update
Vytvoření nebo aktualizace prostředku 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 |
|---|---|---|---|---|
|
linker
|
path | True |
string |
Název prostředku Linkeru. |
|
resource
|
path | True |
string |
Plně kvalifikovaný identifikátor Azure Resource Manageru prostředku, který se má připojit. |
|
api-version
|
query | True |
string minLength: 1 |
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 |
Typ klienta aplikace |
|
| properties.configurationInfo |
Informace o připojení využívané aplikacemi, včetně tajných kódů, připojovacích řetězců. |
|
| properties.publicNetworkSolution |
Síťové řešení. |
|
| properties.scope |
string |
obor připojení ve zdrojové službě. |
| properties.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 |
Řešení virtuální sítě. |
Odpovědi
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Úspěšný. |
|
| 201 Created |
Dlouhotrvající operace. |
|
| Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Zabezpečení
azure_auth
Tok OAuth2 v Azure Active Directory
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
| Name | Description |
|---|---|
| user_impersonation | zosobnění uživatelského účtu |
Příklady
PutLinker
Ukázkový požadavek
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"
}
}
}
}
Ukázková odpověď
{
"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 |
|---|---|
|
Access |
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 |
|
access |
Oprávnění přístupového klíče.
|
|
action |
Volitelný. Označuje řešení veřejné sítě. Pokud je povolení povolené, povolte přístup k veřejné síti cílové služby s nejlepším pokusem. Výchozí nastavení je povolené. Pokud výslovný nesouhlas, odhlaste konfiguraci přístupu k veřejné síti. |
|
allow |
Pokud je hodnota true, povolte službám Azure přístup k cílové službě. |
|
Auth |
Typ ověřování. |
|
Azure |
Vlastnosti prostředku, pokud je typ služby Azure Key Vault |
|
Azure |
Informace o prostředcích Azure, pokud je typ cílové služby AzureResource |
|
client |
Typ klienta aplikace |
|
Configuration |
Informace o konfiguraci použité ke generování konfigurací nebo uložení do aplikací |
|
Confluent |
Vlastnosti služby, pokud cílový typ služby je ConfluentBootstrapServer |
|
Confluent |
Vlastnosti služby, pokud cílový typ služby je ConfluentSchemaRegistry |
|
created |
Typ identity, která prostředek vytvořila. |
|
Dapr |
Metadata komponenty dapr. |
|
Dapr |
Označuje některé další vlastnosti pro typ klienta dapr. |
|
Delete |
Chování čištění označující, jestli se operace vyčištění při odstranění nebo aktualizaci prostředku |
|
Error |
Další informace o chybě správy prostředků |
|
Error |
Podrobnosti o chybě. |
|
Error |
Chybová odpověď |
|
Firewall |
Pravidla brány firewall cílové služby povolit připojení ze zdrojové služby. |
|
Key |
Tajné informace, pokud je typ keyVaultSecretReference. Jedná se o scénář, kdy uživatel poskytuje tajný kód uložený v klíči uživatele a zdroj je Azure Kubernetes. ID prostředku služby Key Vault je propojené s secretStore.keyVaultId. |
|
Key |
Tajné informace, pokud typ je keyVaultSecretUri. Jde o scénář, kdy uživatel poskytuje tajný kód uložený v klíči uživatele a zdroj je Webová aplikace, Spring Cloud nebo Container App. |
|
Linker |
Linker zdrojového a cílového prostředku |
|
Public |
Označuje řešení veřejné sítě, včetně pravidel brány firewall. |
|
Secret |
Ověřovací informace, když je typ ověřování tajný |
|
Secret |
Možnost uložení hodnoty tajného kódu na bezpečném místě |
|
Secret |
Typ tajného kódu. |
|
Self |
Vlastnosti služby, pokud je cílový typ služby SelfHostedServer |
|
Service |
Ověřovací informace, když je authType certifikát servicePrincipal |
|
Service |
Ověřovací informace, když je authType tajný klíč servicePrincipal |
|
System |
Ověřovací informace, když je typ ověřování systemAssignedIdentity |
|
system |
Metadata týkající se vytvoření a poslední změny prostředku. |
|
User |
Ověřovací informace, když je typ ověřování uživatelský účet |
|
User |
Ověřovací informace, když authType je userAssignedIdentity |
|
Value |
Tajné informace, pokud typ je rawValue. Jde o scénáře, které uživatel zadal tajný kód. |
|
VNet |
Řešení virtuální sítě pro linker |
|
v |
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:
access |
Typ ověřování. |
| permissions |
Oprávnění přístupového klíče.
|
accessKeyPermissions
Oprávnění přístupového klíče.
Read a Write jsou určené pro Azure Cosmos DB a Azure App Configuration, Listen, Send a Manage jsou určené pro Azure Event Hub a Azure Service Bus.
| Hodnota | Description |
|---|---|
| Read | |
| Write | |
| Listen | |
| Send | |
| Manage |
actionType
Volitelný. Označuje řešení veřejné sítě. Pokud je povolení povolené, povolte přístup k veřejné síti cílové služby s nejlepším pokusem. Výchozí nastavení je povolené. Pokud výslovný nesouhlas, odhlaste konfiguraci přístupu k veřejné síti.
| Hodnota | Description |
|---|---|
| enable | |
| optOut |
allowType
Pokud je hodnota true, povolte službám Azure přístup k cílové službě.
| Hodnota | Description |
|---|---|
| true | |
| false |
AuthType
Typ ověřování.
| Hodnota | Description |
|---|---|
| systemAssignedIdentity | |
| userAssignedIdentity | |
| servicePrincipalSecret | |
| servicePrincipalCertificate | |
| secret | |
| accessKey | |
| userAccount |
AzureKeyVaultProperties
Vlastnosti prostředku, pokud je typ služby Azure Key Vault
| Name | Typ | Description |
|---|---|---|
| connectAsKubernetesCsiDriver |
boolean |
Platí při připojení přes ovladač CSI Kubernetes. |
| type |
string:
Key |
Typ prostředku Azure. |
AzureResource
Informace o prostředcích Azure, pokud je typ cílové služby AzureResource
| Name | Typ | Description |
|---|---|---|
| id |
string |
ID prostředku Azure. |
| resourceProperties | AzureResourcePropertiesBase: |
Vlastnosti související s připojením k prostředkům Azure |
| type | string: |
Typ cílové služby. |
clientType
Typ klienta aplikace
| Hodnota | Description |
|---|---|
| none | |
| dotnet | |
| java | |
| python | |
| go | |
| php | |
| ruby | |
| django | |
| nodejs | |
| springBoot | |
| kafka-springBoot | |
| dapr |
ConfigurationInfo
Informace o konfiguraci použité ke generování konfigurací nebo uložení do aplikací
| Name | Typ | Description |
|---|---|---|
| action |
Volitelné, určete, jestli se mají použít konfigurace ve zdrojové aplikaci. Pokud ji povolíte, vygenerujte konfigurace a použijete ji u zdrojové aplikace. Výchozí nastavení je povolené. Pokud se optOut, ve zdroji se 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 je úplné vyplnění více přizpůsobených konfigurací. |
| customizedKeys |
object |
Volitelný. Slovník výchozího názvu klíče a vlastního mapování názvu klíče. Pokud není zadaný, použije se výchozí název klíče ke generování konfigurací. |
| daprProperties |
Označuje některé další vlastnosti pro typ klienta dapr. |
|
| deleteOrUpdateBehavior |
Určuje, jestli se má při aktualizaci nebo odstranění linkeru vyčistit předchozí operace. |
ConfluentBootstrapServer
Vlastnosti služby, pokud cílový typ služby je ConfluentBootstrapServer
| Name | Typ | Description |
|---|---|---|
| endpoint |
string |
Koncový bod služby. |
| type | string: |
Typ cílové služby. |
ConfluentSchemaRegistry
Vlastnosti služby, pokud cílový typ služby je ConfluentSchemaRegistry
| Name | Typ | Description |
|---|---|---|
| endpoint |
string |
Koncový bod služby. |
| type | string: |
Typ cílové služby. |
createdByType
Typ identity, která prostředek vytvořila.
| Hodnota | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DaprMetadata
Metadata komponenty dapr.
| Name | Typ | Description |
|---|---|---|
| name |
string |
Název vlastnosti metadat. |
| secretRef |
string |
Název tajného kódu, ve kterém může dapr 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 |
Další metadata dapr |
|
| scopes |
string[] |
Obory komponent dapr |
| secretStoreComponent |
string |
Název dapr úložiště tajných kódů pro načtení tajného kódu |
| version |
string |
Verze komponenty dapr |
DeleteOrUpdateBehavior
Chování čištění označující, jestli se operace vyčištění při odstranění nebo aktualizaci prostředku
| Hodnota | Description |
|---|---|
| Default | |
| ForcedCleanup |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
| Name | Typ | Description |
|---|---|---|
| info |
object |
Další informace. |
| type |
string |
Další typ informací. |
ErrorDetail
Podrobnosti o chybě.
| Name | Typ | Description |
|---|---|---|
| additionalInfo |
Další informace o chybě. |
|
| code |
string |
Kód chyby. |
| details |
Podrobnosti o chybě. |
|
| message |
string |
Chybová zpráva. |
| target |
string |
Cíl chyby. |
ErrorResponse
Chybová odpověď
| Name | Typ | Description |
|---|---|---|
| error |
Objekt chyby. |
FirewallRules
Pravidla brány firewall cílové služby povolit připojení ze zdrojové služby.
| Name | Typ | Description |
|---|---|---|
| azureServices |
Pokud je hodnota true, povolte službám Azure přístup k cílové službě. |
|
| callerClientIP |
Pokud je hodnota true, povolte IP adresu klienta volajícího přístup k cílové službě. 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 mají zahrnout jako seznam povolených IP adres klienta pro daný databázový účet. |
KeyVaultSecretReferenceSecretInfo
Tajné informace, pokud je typ keyVaultSecretReference. Jedná se o scénář, kdy uživatel poskytuje tajný kód uložený v klíči uživatele a zdroj je Azure Kubernetes. ID prostředku služby Key Vault je propojené s secretStore.keyVaultId.
| Name | Typ | Description |
|---|---|---|
| name |
string |
Název tajného klíče služby Key Vault. |
| secretType |
string:
key |
Typ tajného kódu. |
| version |
string |
Verze tajného klíče služby Key Vault. |
KeyVaultSecretUriSecretInfo
Tajné informace, pokud typ je keyVaultSecretUri. Jde o scénář, kdy uživatel poskytuje tajný kód uložený v klíči uživatele a zdroj je Webová aplikace, Spring Cloud nebo Container App.
| Name | Typ | Description |
|---|---|---|
| secretType |
string:
key |
Typ tajného kódu. |
| value |
string |
Identifikátor URI tajného klíče služby KeyVault |
LinkerResource
Linker zdrojového a cílového prostředku
| Name | Typ | Description |
|---|---|---|
| id |
string |
Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| name |
string |
Název prostředku |
| properties.authInfo | AuthInfoBase: |
Typ ověřování. |
| properties.clientType |
Typ klienta aplikace |
|
| properties.configurationInfo |
Informace o připojení využívané aplikacemi, včetně tajných kódů, připojovacích řetězců. |
|
| properties.provisioningState |
string |
Stav zřizování. |
| properties.publicNetworkSolution |
Síťové řešení. |
|
| properties.scope |
string |
obor připojení ve zdrojové službě. |
| properties.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 |
Řešení virtuální sítě. |
|
| 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ě, včetně pravidel brány firewall.
| Name | Typ | Description |
|---|---|---|
| action |
Volitelný. Označuje řešení veřejné sítě. Pokud je povolení povolené, povolte přístup k veřejné síti cílové služby s nejlepším pokusem. Výchozí nastavení je povolené. Pokud výslovný nesouhlas, odhlaste konfiguraci přístupu k veřejné síti. |
|
| deleteOrUpdateBehavior |
Označuje, jestli se má při aktualizaci nebo odstraňování linkeru vyčistit předchozí operace (například pravidla brány firewall). |
|
| firewallRules |
Popište pravidla brány firewall cílové služby, abyste měli jistotu, že se zdrojová aplikace může připojit k cíli. |
SecretAuthInfo
Ověřovací informace, když je typ ověřování tajný
| 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: |
Tajný klíč hesla nebo 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 klíče trezoru klíčů pro uložení tajného kódu, platný pouze při ukládání jednoho tajného kódu. |
SecretType
Typ tajného kódu.
| Hodnota | Description |
|---|---|
| rawValue | |
| keyVaultSecretUri | |
| keyVaultSecretReference |
SelfHostedServer
Vlastnosti služby, pokud je cílový typ služby SelfHostedServer
| Name | Typ | Description |
|---|---|---|
| endpoint |
string |
Koncový bod služby. |
| type | string: |
Typ cílové služby. |
ServicePrincipalCertificateAuthInfo
Ověřovací informace, když je authType certifikát servicePrincipal
| Name | Typ | Description |
|---|---|---|
| authType |
string:
service |
Typ ověřování. |
| certificate |
string |
Certifikát ServicePrincipal pro ověřování servicePrincipal |
| clientId |
string |
ID klienta aplikace pro ověřování instančního objektu. |
| deleteOrUpdateBehavior |
Určuje, jestli se má při aktualizaci nebo odstranění linkeru vyčistit předchozí operace. |
|
| principalId |
string |
ID objektu zabezpečení pro ověřování servicePrincipal. |
| roles |
string[] |
Nepovinný argument, tato 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:
service |
Typ ověřování. |
| clientId |
string |
Id klienta aplikace ServicePrincipal pro ověřování ServicePrincipal |
| deleteOrUpdateBehavior |
Určuje, jestli se má při aktualizaci nebo odstranění linkeru vyčistit předchozí operace. |
|
| principalId |
string |
ID objektu zabezpečení pro ověřování servicePrincipal. |
| roles |
string[] |
Nepovinný argument, tato 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 namapováno na uživatele v AAD. |
SystemAssignedIdentityAuthInfo
Ověřovací informace, když je typ ověřování systemAssignedIdentity
| Name | Typ | Description |
|---|---|---|
| authType |
string:
system |
Typ ověřování. |
| deleteOrUpdateBehavior |
Určuje, jestli se má při aktualizaci nebo odstranění linkeru vyčistit předchozí operace. |
|
| 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 namapováno na uživatele v AAD. |
systemData
Metadata týkající se vytvoření a poslední změny prostředku.
| Name | Typ | Description |
|---|---|---|
| createdAt |
string (date-time) |
Časové razítko vytvoření prostředku (UTC). |
| createdBy |
string |
Identita, která prostředek vytvořila. |
| createdByType |
Typ identity, která prostředek vytvořila. |
|
| lastModifiedAt |
string (date-time) |
Časové razítko poslední změny zdroje (UTC) |
| lastModifiedBy |
string |
Identita, která naposledy změnila prostředek. |
| lastModifiedByType |
Typ identity, která naposledy změnila prostředek. |
UserAccountAuthInfo
Ověřovací informace, když je typ ověřování uživatelský účet
| Name | Typ | Description |
|---|---|---|
| authType |
string:
user |
Typ ověřování. |
| deleteOrUpdateBehavior |
Určuje, jestli se má při aktualizaci nebo odstranění linkeru vyčistit předchozí operace. |
|
| principalId |
string |
ID objektu zabezpečení pro uživatelský účet |
| roles |
string[] |
Nepovinný argument, tato 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 namapováno na uživatele v AAD. |
UserAssignedIdentityAuthInfo
Ověřovací informace, když authType je userAssignedIdentity
| Name | Typ | Description |
|---|---|---|
| authType |
string:
user |
Typ ověřování. |
| clientId |
string |
ID klienta pro userAssignedIdentity. |
| deleteOrUpdateBehavior |
Určuje, jestli se má při aktualizaci nebo odstranění linkeru vyčistit předchozí operace. |
|
| 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 namapováno na uživatele v AAD. |
ValueSecretInfo
Tajné informace, pokud typ je rawValue. Jde o scénáře, které uživatel zadal tajný kód.
| Name | Typ | Description |
|---|---|---|
| secretType |
string:
raw |
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 |
Určuje, jestli se má při aktualizaci nebo odstranění linkeru vyčistit předchozí operace. |
|
| type |
Typ řešení virtuální sítě |
vNetSolutionType
Typ řešení virtuální sítě
| Hodnota | Description |
|---|---|
| serviceEndpoint | |
| privateLink |