Linker - Create Or Update
Creare o aggiornare la risorsa linker.
PUT https://management.azure.com/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}?api-version=2022-11-01-preview
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
linker
|
path | True |
string |
Risorsa linker nome. |
resource
|
path | True |
string |
Identificatore completo di Azure Resource Manager della risorsa da connettere. |
api-version
|
query | True |
string |
Versione dell'API da usare per questa operazione. |
Corpo della richiesta
Nome | Tipo | Descrizione |
---|---|---|
properties.authInfo | AuthInfoBase: |
Tipo di autenticazione. |
properties.clientType |
Tipo di client dell'applicazione |
|
properties.configurationInfo |
Le informazioni di connessione usate dalle applicazioni, inclusi segreti, stringhe di connessione. |
|
properties.publicNetworkSolution |
Soluzione di rete. |
|
properties.scope |
string |
ambito di connessione nel servizio di origine. |
properties.secretStore |
Opzione per archiviare il valore segreto nel posto sicuro |
|
properties.targetService | TargetServiceBase: |
Proprietà del servizio di destinazione |
properties.vNetSolution |
Soluzione rete virtuale. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Successo. |
|
201 Created |
Operazione a esecuzione prolungata. |
|
Other Status Codes |
Risposta di errore che descrive perché l'operazione non è riuscita. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
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"
}
}
}
Definizioni
Nome | Descrizione |
---|---|
Access |
Chiave di accesso direttamente dalle proprietà delle risorse di destinazione, il servizio di destinazione è Risorsa di Azure, ad esempio Microsoft.Storage |
access |
Autorizzazioni dell'accessKey. |
action |
facoltativo. Indica la soluzione di rete pubblica. Se si abilita, abilitare l'accesso di rete pubblico del servizio di destinazione con il miglior tentativo. Il valore predefinito è abilitato. Se si optOut, rifiutare la configurazione dell'accesso alla rete pubblica. |
allow |
Consentire ai servizi di Azure di accedere al servizio di destinazione se true. |
Auth |
Tipo di autenticazione. |
Azure |
Proprietà della risorsa quando il tipo è Azure Key Vault |
Azure |
Informazioni sulle risorse di Azure quando il tipo di servizio di destinazione è AzureResource |
client |
Tipo di client dell'applicazione |
Configuration |
Informazioni di configurazione, usate per generare configurazioni o salvare nelle applicazioni |
Confluent |
Le proprietà del servizio quando il tipo di servizio di destinazione è ConfluentBootstrapServer |
Confluent |
Le proprietà del servizio quando il tipo di servizio di destinazione è ConfluentSchemaRegistry |
created |
Tipo di identità che ha creato la risorsa. |
Dapr |
Metadati del componente dapr. |
Dapr |
Indica alcune proprietà aggiuntive per il tipo di client dapr |
Delete |
Comportamento di pulizia per indicare se l'operazione di pulizia viene eliminata o aggiornata quando la risorsa viene eliminata o aggiornata |
Error |
Informazioni aggiuntive sulla gestione delle risorse. |
Error |
Dettagli dell'errore. |
Error |
Risposta di errore |
Firewall |
Regole del firewall del servizio di destinazione. per consentire le connessioni dal servizio di origine. |
Key |
Informazioni segrete quando il tipo è keyVaultSecretReference. È per lo scenario in cui l'utente fornisce un segreto archiviato nella chiavevault dell'utente e l'origine è Azure Kubernetes. L'ID risorsa dell'insieme di credenziali delle chiavi è collegato a secretStore.keyVaultId. |
Key |
Informazioni segrete quando il tipo è keyVaultSecretUri. È per lo scenario in cui l'utente fornisce un segreto archiviato nella chiavevault dell'utente e l'origine è App Web, Spring Cloud o Container App. |
Linker |
Linker della risorsa di origine e di destinazione |
Public |
Indica la soluzione di rete pubblica, includere regole del firewall |
Secret |
Informazioni di autenticazione quando authType è segreto |
Secret |
Opzione per archiviare il valore segreto nel posto sicuro |
Secret |
Tipo di segreto. |
Self |
Le proprietà del servizio quando il tipo di servizio di destinazione è SelfHostedServer |
Service |
Informazioni di autenticazione quando authType è un certificato servicePrincipal |
Service |
Informazioni di autenticazione quando authType è il segreto servicePrincipal |
System |
Informazioni di autenticazione quando authType è systemAssignedIdentity |
system |
Metadati relativi alla creazione e all'ultima modifica della risorsa. |
User |
Informazioni di autenticazione quando authType è account utente |
User |
Informazioni di autenticazione quando authType è userAssignedIdentity |
Value |
Informazioni segrete quando il tipo è rawValue. È per gli scenari in cui l'utente inserisce il segreto. |
VNet |
Soluzione di rete virtuale per il linker |
v |
Tipo di soluzione rete virtuale. |
AccessKeyInfoBase
Chiave di accesso direttamente dalle proprietà delle risorse di destinazione, il servizio di destinazione è Risorsa di Azure, ad esempio Microsoft.Storage
Nome | Tipo | Descrizione |
---|---|---|
authType |
string:
access |
Tipo di autenticazione. |
permissions |
Autorizzazioni dell'accessKey. |
accessKeyPermissions
Autorizzazioni dell'accessKey. Read
e Write
sono per Azure Cosmos DB e Configurazione app di Azure, Listen
Send
e Manage
sono per Hub eventi di Azure e bus di servizio di Azure.
Nome | Tipo | Descrizione |
---|---|---|
Listen |
string |
|
Manage |
string |
|
Read |
string |
|
Send |
string |
|
Write |
string |
actionType
facoltativo. Indica la soluzione di rete pubblica. Se si abilita, abilitare l'accesso di rete pubblico del servizio di destinazione con il miglior tentativo. Il valore predefinito è abilitato. Se si optOut, rifiutare la configurazione dell'accesso alla rete pubblica.
Nome | Tipo | Descrizione |
---|---|---|
enable |
string |
|
optOut |
string |
allowType
Consentire ai servizi di Azure di accedere al servizio di destinazione se true.
Nome | Tipo | Descrizione |
---|---|---|
false |
string |
|
true |
string |
AuthType
Tipo di autenticazione.
Nome | Tipo | Descrizione |
---|---|---|
accessKey |
string |
|
secret |
string |
|
servicePrincipalCertificate |
string |
|
servicePrincipalSecret |
string |
|
systemAssignedIdentity |
string |
|
userAccount |
string |
|
userAssignedIdentity |
string |
AzureKeyVaultProperties
Proprietà della risorsa quando il tipo è Azure Key Vault
Nome | Tipo | Descrizione |
---|---|---|
connectAsKubernetesCsiDriver |
boolean |
True se ci si connette tramite Kubernetes CSI Driver. |
type |
string:
Key |
Tipo di risorsa di Azure. |
AzureResource
Informazioni sulle risorse di Azure quando il tipo di servizio di destinazione è AzureResource
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID della risorsa di Azure. |
resourceProperties | AzureResourcePropertiesBase: |
Proprietà correlate alla connessione alle risorse di Azure. |
type | string: |
Tipo di servizio di destinazione. |
clientType
Tipo di client dell'applicazione
Nome | Tipo | Descrizione |
---|---|---|
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
Informazioni di configurazione, usate per generare configurazioni o salvare nelle applicazioni
Nome | Tipo | Descrizione |
---|---|---|
action |
Facoltativo, indicare se applicare configurazioni nell'applicazione di origine. In caso di abilitazione, generare configurazioni e applicare all'applicazione di origine. Il valore predefinito è abilitato. Se optOut, non verrà apportata alcuna modifica di configurazione all'origine. |
|
additionalConfigurations |
object |
Dizionario di configurazioni aggiuntive da aggiungere. Il servizio genererà automaticamente un set di configurazioni di base e questa proprietà consiste nel riempire più configurazioni personalizzate |
customizedKeys |
object |
facoltativo. Dizionario di nome chiave predefinito e mapping dei nomi delle chiavi personalizzati. Se non specificato, il nome della chiave predefinita verrà usato per generare configurazioni |
daprProperties |
Indica alcune proprietà aggiuntive per il tipo di client dapr |
|
deleteOrUpdateBehavior |
Indica se pulire l'operazione precedente durante l'aggiornamento o l'eliminazione del linker |
ConfluentBootstrapServer
Le proprietà del servizio quando il tipo di servizio di destinazione è ConfluentBootstrapServer
Nome | Tipo | Descrizione |
---|---|---|
endpoint |
string |
Endpoint del servizio. |
type | string: |
Tipo di servizio di destinazione. |
ConfluentSchemaRegistry
Le proprietà del servizio quando il tipo di servizio di destinazione è ConfluentSchemaRegistry
Nome | Tipo | Descrizione |
---|---|---|
endpoint |
string |
Endpoint del servizio. |
type | string: |
Tipo di servizio di destinazione. |
createdByType
Tipo di identità che ha creato la risorsa.
Nome | Tipo | Descrizione |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DaprMetadata
Metadati del componente dapr.
Nome | Tipo | Descrizione |
---|---|---|
name |
string |
Nome della proprietà dei metadati. |
secretRef |
string |
Nome segreto in cui dapr potrebbe ottenere valore |
value |
string |
Valore della proprietà dei metadati. |
DaprProperties
Indica alcune proprietà aggiuntive per il tipo di client dapr
Nome | Tipo | Descrizione |
---|---|---|
componentType |
string |
Tipo di componente dapr |
metadata |
Metadati dapr aggiuntivi |
|
scopes |
string[] |
Ambiti del componente dapr |
secretStoreComponent |
string |
Nome di un archivio segreto dapr per recuperare il segreto |
version |
string |
Versione del componente dapr |
DeleteOrUpdateBehavior
Comportamento di pulizia per indicare se l'operazione di pulizia viene eliminata o aggiornata quando la risorsa viene eliminata o aggiornata
Nome | Tipo | Descrizione |
---|---|---|
Default |
string |
|
ForcedCleanup |
string |
ErrorAdditionalInfo
Informazioni aggiuntive sulla gestione delle risorse.
Nome | Tipo | Descrizione |
---|---|---|
info |
object |
Informazioni aggiuntive. |
type |
string |
Tipo di informazioni aggiuntive. |
ErrorDetail
Dettagli dell'errore.
Nome | Tipo | Descrizione |
---|---|---|
additionalInfo |
Informazioni aggiuntive sull'errore. |
|
code |
string |
Codice di errore. |
details |
Dettagli dell'errore. |
|
message |
string |
Messaggio di errore. |
target |
string |
Destinazione dell'errore. |
ErrorResponse
Risposta di errore
Nome | Tipo | Descrizione |
---|---|---|
error |
Oggetto error. |
FirewallRules
Regole del firewall del servizio di destinazione. per consentire le connessioni dal servizio di origine.
Nome | Tipo | Descrizione |
---|---|---|
azureServices |
Consentire ai servizi di Azure di accedere al servizio di destinazione se true. |
|
callerClientIP |
Consenti all'IP client del chiamante di accedere al servizio di destinazione se true. la proprietà viene usata durante la connessione dell'applicazione locale al servizio di destinazione. |
|
ipRanges |
string[] |
Questo valore specifica il set di indirizzi IP o intervalli di indirizzi IP nel formato CIDR da includere come elenco consentito di indirizzi IP client per un determinato account di database. |
KeyVaultSecretReferenceSecretInfo
Informazioni segrete quando il tipo è keyVaultSecretReference. È per lo scenario in cui l'utente fornisce un segreto archiviato nella chiavevault dell'utente e l'origine è Azure Kubernetes. L'ID risorsa dell'insieme di credenziali delle chiavi è collegato a secretStore.keyVaultId.
Nome | Tipo | Descrizione |
---|---|---|
name |
string |
Nome del segreto Key Vault. |
secretType |
string:
key |
Tipo di segreto. |
version |
string |
Versione del segreto Key Vault. |
KeyVaultSecretUriSecretInfo
Informazioni segrete quando il tipo è keyVaultSecretUri. È per lo scenario in cui l'utente fornisce un segreto archiviato nella chiavevault dell'utente e l'origine è App Web, Spring Cloud o Container App.
Nome | Tipo | Descrizione |
---|---|---|
secretType |
string:
key |
Tipo di segreto. |
value |
string |
URI al segreto keyvault |
LinkerResource
Linker della risorsa di origine e di destinazione
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
nome della risorsa. |
properties.authInfo | AuthInfoBase: |
Tipo di autenticazione. |
properties.clientType |
Tipo di client dell'applicazione |
|
properties.configurationInfo |
Le informazioni di connessione usate dalle applicazioni, inclusi segreti, stringhe di connessione. |
|
properties.provisioningState |
string |
Stato di provisioning. |
properties.publicNetworkSolution |
Soluzione di rete. |
|
properties.scope |
string |
ambito di connessione nel servizio di origine. |
properties.secretStore |
Opzione per archiviare il valore segreto nel posto sicuro |
|
properties.targetService | TargetServiceBase: |
Proprietà del servizio di destinazione |
properties.vNetSolution |
Soluzione rete virtuale. |
|
systemData |
Dati di sistema. |
|
type |
string |
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
PublicNetworkSolution
Indica la soluzione di rete pubblica, includere regole del firewall
Nome | Tipo | Descrizione |
---|---|---|
action |
facoltativo. Indica la soluzione di rete pubblica. Se si abilita, abilitare l'accesso di rete pubblico del servizio di destinazione con il miglior tentativo. Il valore predefinito è abilitato. Se si optOut, rifiutare la configurazione dell'accesso alla rete pubblica. |
|
deleteOrUpdateBehavior |
Indica se pulire l'operazione precedente(ad esempio le regole del firewall) quando Il linker sta aggiornando o eliminando |
|
firewallRules |
Descrivere le regole del firewall del servizio di destinazione per assicurarsi che l'applicazione di origine possa connettersi alla destinazione. |
SecretAuthInfo
Informazioni di autenticazione quando authType è segreto
Nome | Tipo | Descrizione |
---|---|---|
authType |
string:
secret |
Tipo di autenticazione. |
name |
string |
Nome utente o nome account per l'autenticazione privata. |
secretInfo | SecretInfoBase: |
Password o segreto dell'insieme di credenziali delle chiavi per l'autenticazione privata. |
SecretStore
Opzione per archiviare il valore segreto nel posto sicuro
Nome | Tipo | Descrizione |
---|---|---|
keyVaultId |
string |
ID dell'insieme di credenziali delle chiavi per archiviare il segreto |
keyVaultSecretName |
string |
Nome segreto dell'insieme di credenziali delle chiavi per archiviare il segreto, valido solo quando si archivia un segreto |
SecretType
Tipo di segreto.
Nome | Tipo | Descrizione |
---|---|---|
keyVaultSecretReference |
string |
|
keyVaultSecretUri |
string |
|
rawValue |
string |
SelfHostedServer
Le proprietà del servizio quando il tipo di servizio di destinazione è SelfHostedServer
Nome | Tipo | Descrizione |
---|---|---|
endpoint |
string |
Endpoint del servizio. |
type | string: |
Tipo di servizio di destinazione. |
ServicePrincipalCertificateAuthInfo
Informazioni di autenticazione quando authType è un certificato servicePrincipal
Nome | Tipo | Descrizione |
---|---|---|
authType |
string:
service |
Tipo di autenticazione. |
certificate |
string |
Certificato ServicePrincipal per l'autenticazione servicePrincipal. |
clientId |
string |
Client dell'applicazione per l'autenticazione servicePrincipal. |
deleteOrUpdateBehavior |
Indica se pulire l'operazione precedente durante l'aggiornamento o l'eliminazione del linker |
|
principalId |
string |
ID entità per l'autenticazione servicePrincipal. |
roles |
string[] |
Facoltativo, questo valore specifica i ruoli di Azure da assegnare. Automatico |
ServicePrincipalSecretAuthInfo
Informazioni di autenticazione quando authType è il segreto servicePrincipal
Nome | Tipo | Descrizione |
---|---|---|
authType |
string:
service |
Tipo di autenticazione. |
clientId |
string |
Client client dell'applicazione ServicePrincipal per l'autenticazione servicePrincipal. |
deleteOrUpdateBehavior |
Indica se pulire l'operazione precedente durante l'aggiornamento o l'eliminazione del linker |
|
principalId |
string |
ID entità per l'autenticazione servicePrincipal. |
roles |
string[] |
Facoltativo, questo valore specifica i ruoli di Azure da assegnare. Automatico |
secret |
string |
Segreto per l'autenticazione servicePrincipal. |
userName |
string |
Nome utente creato nel database mappato a un utente in AAD. |
SystemAssignedIdentityAuthInfo
Informazioni di autenticazione quando authType è systemAssignedIdentity
Nome | Tipo | Descrizione |
---|---|---|
authType |
string:
system |
Tipo di autenticazione. |
deleteOrUpdateBehavior |
Indica se pulire l'operazione precedente durante l'aggiornamento o l'eliminazione del linker |
|
roles |
string[] |
Facoltativo, questo valore specifica il ruolo di Azure da assegnare |
userName |
string |
Nome utente creato nel database mappato a un utente in AAD. |
systemData
Metadati relativi alla creazione e all'ultima modifica della risorsa.
Nome | Tipo | Descrizione |
---|---|---|
createdAt |
string |
Timestamp della creazione di risorse (UTC). |
createdBy |
string |
Identità che ha creato la risorsa. |
createdByType |
Tipo di identità che ha creato la risorsa. |
|
lastModifiedAt |
string |
Timestamp dell'ultima modifica della risorsa (UTC) |
lastModifiedBy |
string |
Identità che ha modificato l'ultima risorsa. |
lastModifiedByType |
Tipo di identità che ha modificato l'ultima risorsa. |
UserAccountAuthInfo
Informazioni di autenticazione quando authType è account utente
Nome | Tipo | Descrizione |
---|---|---|
authType |
string:
user |
Tipo di autenticazione. |
deleteOrUpdateBehavior |
Indica se pulire l'operazione precedente durante l'aggiornamento o l'eliminazione del linker |
|
principalId |
string |
ID entità per l'account utente. |
roles |
string[] |
Facoltativo, questo valore specifica i ruoli di Azure da assegnare. Automatico |
userName |
string |
Nome utente creato nel database mappato a un utente in AAD. |
UserAssignedIdentityAuthInfo
Informazioni di autenticazione quando authType è userAssignedIdentity
Nome | Tipo | Descrizione |
---|---|---|
authType |
string:
user |
Tipo di autenticazione. |
clientId |
string |
ID client per userAssignedIdentity. |
deleteOrUpdateBehavior |
Indica se pulire l'operazione precedente durante l'aggiornamento o l'eliminazione del linker |
|
roles |
string[] |
Facoltativo, questo valore specifica il ruolo di Azure da assegnare |
subscriptionId |
string |
ID sottoscrizione per userAssignedIdentity. |
userName |
string |
Nome utente creato nel database mappato a un utente in AAD. |
ValueSecretInfo
Informazioni segrete quando il tipo è rawValue. È per gli scenari in cui l'utente inserisce il segreto.
Nome | Tipo | Descrizione |
---|---|---|
secretType |
string:
raw |
Tipo di segreto. |
value |
string |
Valore effettivo del segreto. |
VNetSolution
Soluzione di rete virtuale per il linker
Nome | Tipo | Descrizione |
---|---|---|
deleteOrUpdateBehavior |
Indica se pulire l'operazione precedente durante l'aggiornamento o l'eliminazione del linker |
|
type |
Tipo di soluzione rete virtuale. |
vNetSolutionType
Tipo di soluzione rete virtuale.
Nome | Tipo | Descrizione |
---|---|---|
privateLink |
string |
|
serviceEndpoint |
string |