Partager via


Connector - Update

Opération de mise à jour d’un connecteur existant.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}?api-version=2022-11-01-preview

Paramètres URI

Nom Dans Obligatoire Type Description
connectorName
path True

string

Nom de la ressource.

location
path True

string

minLength: 1

Nom de la région Azure.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nom du groupe de ressources. Le nom ne respecte pas la casse.

subscriptionId
path True

string

minLength: 1

ID de l’abonnement cible.

api-version
query True

string

minLength: 1

Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom Type Description
properties.authInfo AuthInfoBase:

Type d’authentification.

properties.clientType

clientType

Type de client d’application

properties.configurationInfo

ConfigurationInfo

Informations de connexion consommées par les applications, y compris les secrets, les chaînes de connexion.

properties.publicNetworkSolution

PublicNetworkSolution

Solution réseau.

properties.scope

string

étendue de connexion dans le service source.

properties.secretStore

SecretStore

Option permettant de stocker la valeur secrète en lieu sécurisé

properties.targetService TargetServiceBase:

Propriétés du service cible

properties.vNetSolution

VNetSolution

Solution de réseau virtuel.

Réponses

Nom Type Description
200 OK

LinkerResource

Succès. La réponse décrit un connecteur.

202 Accepted

LinkerResource

Opération longue.

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

PatchConnector

Exemple de requête

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/connectors/connectorName?api-version=2022-11-01-preview

{
  "properties": {
    "targetService": {
      "type": "AzureResource",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
    },
    "authInfo": {
      "authType": "servicePrincipalSecret",
      "clientId": "name",
      "principalId": "id",
      "secret": "secret"
    }
  }
}

Exemple de réponse

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName",
  "type": "Microsoft.ServiceLinker/links",
  "name": "linkName",
  "properties": {
    "authInfo": {
      "authType": "servicePrincipalSecret",
      "clientId": "name",
      "principalId": "id"
    },
    "targetService": {
      "type": "AzureResource",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
    }
  }
}
azure-asyncoperation: http://azure.async.operation/status
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName",
  "type": "Microsoft.ServiceLinker/links",
  "name": "linkName",
  "properties": {
    "authInfo": {
      "authType": "servicePrincipalSecret",
      "clientId": "name",
      "principalId": "id"
    },
    "targetService": {
      "type": "AzureResource",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
    }
  }
}

Définitions

Nom Description
AccessKeyInfoBase

Clé d’accès directement à partir des propriétés de ressource cible, dont le service cible est Une ressource Azure, telle que Microsoft.Storage

accessKeyPermissions

Autorisations de l’accessKey. Read et Write concernent Azure Cosmos DB et Azure App Configuration, Listen, Send et Manage sont destinés à Azure Event Hub et Azure Service Bus.

actionType

Optionnel. Indique la solution de réseau public. Si cette option est active, activez l’accès au réseau public du service cible avec le meilleur essai. La valeur par défaut est activée. Si vous optez, désactivez la configuration d’accès au réseau public.

allowType

Autoriser les services Azure à accéder au service cible si la valeur est true.

AuthType

Type d’authentification.

AzureKeyVaultProperties

Propriétés de la ressource quand le type est Azure Key Vault

AzureResource

Informations sur les ressources Azure lorsque le type de service cible est AzureResource

clientType

Type de client d’application

ConfigurationInfo

Informations de configuration, utilisées pour générer des configurations ou enregistrer dans des applications

ConfluentBootstrapServer

Les propriétés du service lorsque le type de service cible est ConfluentBootstrapServer

ConfluentSchemaRegistry

Les propriétés du service lorsque le type de service cible est ConfluentSchemaRegistry

createdByType

Type d’identité qui a créé la ressource.

DaprMetadata

Métadonnées du composant dapr.

DaprProperties

Indique certaines propriétés supplémentaires pour le type de client dapr

DeleteOrUpdateBehavior

Comportement de nettoyage pour indiquer si l’opération de nettoyage est supprimée ou mise à jour de la ressource

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

FirewallRules

Règles de pare-feu du service cible. pour autoriser les connexions à partir du service source.

KeyVaultSecretReferenceSecretInfo

Informations secrètes lorsque le type est keyVaultSecretReference. Il s’agit du scénario où l’utilisateur fournit un secret stocké dans le coffre de clés et la source de l’utilisateur est Azure Kubernetes. L’ID de ressource du coffre de clés est lié à secretStore.keyVaultId.

KeyVaultSecretUriSecretInfo

Informations secrètes lorsque le type est keyVaultSecretUri. Il s’agit du scénario où l’utilisateur fournit un secret stocké dans le coffre de clés de l’utilisateur et sa source est Web App, Spring Cloud ou Container App.

LinkerPatch

Éditeur de liens à mettre à jour.

LinkerResource

Éditeur de liens de ressource source et cible

PublicNetworkSolution

Indique la solution de réseau public, inclure des règles de pare-feu

SecretAuthInfo

Informations d’authentification quand authType est secret

SecretStore

Option permettant de stocker la valeur secrète en lieu sécurisé

SecretType

Type de secret.

SelfHostedServer

Propriétés du service lorsque le type de service cible est SelfHostedServer

ServicePrincipalCertificateAuthInfo

Informations d’authentification quand authType est un certificat servicePrincipal

ServicePrincipalSecretAuthInfo

Informations d’authentification quand authType est un secret servicePrincipal

SystemAssignedIdentityAuthInfo

Informations d’authentification lorsque authType est systemAssignedIdentity

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

UserAccountAuthInfo

Informations d’authentification lorsque authType est le compte d’utilisateur

UserAssignedIdentityAuthInfo

Informations d’authentification lorsque authType est userAssignedIdentity

ValueSecretInfo

Informations secrètes lorsque le type est rawValue. C’est pour les scénarios que l’utilisateur entre le secret.

VNetSolution

Solution de réseau virtuel pour l’éditeur de liens

vNetSolutionType

Type de solution de réseau virtuel.

AccessKeyInfoBase

Clé d’accès directement à partir des propriétés de ressource cible, dont le service cible est Une ressource Azure, telle que Microsoft.Storage

Nom Type Description
authType string:

accessKey

Type d’authentification.

permissions

accessKeyPermissions[]

Autorisations de l’accessKey. Read et Write concernent Azure Cosmos DB et Azure App Configuration, Listen, Send et Manage sont destinés à Azure Event Hub et Azure Service Bus.

accessKeyPermissions

Autorisations de l’accessKey. Read et Write concernent Azure Cosmos DB et Azure App Configuration, Listen, Send et Manage sont destinés à Azure Event Hub et Azure Service Bus.

Valeur Description
Listen
Manage
Read
Send
Write

actionType

Optionnel. Indique la solution de réseau public. Si cette option est active, activez l’accès au réseau public du service cible avec le meilleur essai. La valeur par défaut est activée. Si vous optez, désactivez la configuration d’accès au réseau public.

Valeur Description
enable
optOut

allowType

Autoriser les services Azure à accéder au service cible si la valeur est true.

Valeur Description
false
true

AuthType

Type d’authentification.

Valeur Description
accessKey
secret
servicePrincipalCertificate
servicePrincipalSecret
systemAssignedIdentity
userAccount
userAssignedIdentity

AzureKeyVaultProperties

Propriétés de la ressource quand le type est Azure Key Vault

Nom Type Description
connectAsKubernetesCsiDriver

boolean

True si vous vous connectez via le pilote CSI Kubernetes.

type string:

KeyVault

Type de ressource Azure.

AzureResource

Informations sur les ressources Azure lorsque le type de service cible est AzureResource

Nom Type Description
id

string

ID de la ressource Azure.

resourceProperties AzureResourcePropertiesBase:

AzureKeyVaultProperties

Propriétés associées à la connexion de ressources Azure.

type string:

AzureResource

Type de service cible.

clientType

Type de client d’application

Valeur Description
dapr
django
dotnet
go
java
kafka-springBoot
nodejs
none
php
python
ruby
springBoot

ConfigurationInfo

Informations de configuration, utilisées pour générer des configurations ou enregistrer dans des applications

Nom Type Description
action

actionType

Facultatif, indiquez s’il faut appliquer des configurations à l’application source. Si cette option est active, générez des configurations et appliquées à l’application source. La valeur par défaut est activée. Si vous optez, aucune modification de configuration n’est apportée à la source.

additionalConfigurations

object

Dictionnaire de configurations supplémentaires à ajouter. Le service génère automatiquement un ensemble de configurations de base et cette propriété consiste à remplir entièrement des configurations plus personnalisées.

customizedKeys

object

Optionnel. Dictionnaire de nom de clé par défaut et mappage de nom de clé personnalisé. S’il n’est pas spécifié, le nom de clé par défaut est utilisé pour générer des configurations

daprProperties

DaprProperties

Indique certaines propriétés supplémentaires pour le type de client dapr

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Indique s’il faut nettoyer l’opération précédente lorsque Linker met à jour ou supprime

ConfluentBootstrapServer

Les propriétés du service lorsque le type de service cible est ConfluentBootstrapServer

Nom Type Description
endpoint

string

Point de terminaison du service.

type string:

ConfluentBootstrapServer

Type de service cible.

ConfluentSchemaRegistry

Les propriétés du service lorsque le type de service cible est ConfluentSchemaRegistry

Nom Type Description
endpoint

string

Point de terminaison du service.

type string:

ConfluentSchemaRegistry

Type de service cible.

createdByType

Type d’identité qui a créé la ressource.

Valeur Description
Application
Key
ManagedIdentity
User

DaprMetadata

Métadonnées du composant dapr.

Nom Type Description
name

string

Nom de la propriété de métadonnées.

secretRef

string

Nom du secret où dapr peut obtenir la valeur

value

string

Valeur de propriété de métadonnées.

DaprProperties

Indique certaines propriétés supplémentaires pour le type de client dapr

Nom Type Description
componentType

string

Type de composant dapr

metadata

DaprMetadata[]

Métadonnées dapr supplémentaires

scopes

string[]

Étendues des composants dapr

secretStoreComponent

string

Nom d’un dapr de magasin de secrets pour récupérer le secret

version

string

Version du composant dapr

DeleteOrUpdateBehavior

Comportement de nettoyage pour indiquer si l’opération de nettoyage est supprimée ou mise à jour de la ressource

Valeur Description
Default
ForcedCleanup

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.

type

string

Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d’erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

FirewallRules

Règles de pare-feu du service cible. pour autoriser les connexions à partir du service source.

Nom Type Description
azureServices

allowType

Autoriser les services Azure à accéder au service cible si la valeur est true.

callerClientIP

allowType

Autoriser l’adresse IP du client de l’appelant à accéder au service cible si la valeur est true. la propriété est utilisée lors de la connexion de l’application locale au service cible.

ipRanges

string[]

Cette valeur spécifie l’ensemble d’adresses IP ou de plages d’adresses IP sous forme CIDR à inclure comme liste autorisée d’adresses IP clientes pour un compte de base de données donné.

KeyVaultSecretReferenceSecretInfo

Informations secrètes lorsque le type est keyVaultSecretReference. Il s’agit du scénario où l’utilisateur fournit un secret stocké dans le coffre de clés et la source de l’utilisateur est Azure Kubernetes. L’ID de ressource du coffre de clés est lié à secretStore.keyVaultId.

Nom Type Description
name

string

Nom du secret Key Vault.

secretType string:

keyVaultSecretReference

Type de secret.

version

string

Version du secret Key Vault.

KeyVaultSecretUriSecretInfo

Informations secrètes lorsque le type est keyVaultSecretUri. Il s’agit du scénario où l’utilisateur fournit un secret stocké dans le coffre de clés de l’utilisateur et sa source est Web App, Spring Cloud ou Container App.

Nom Type Description
secretType string:

keyVaultSecretUri

Type de secret.

value

string

URI vers le secret de coffre de clés

LinkerPatch

Éditeur de liens à mettre à jour.

Nom Type Description
properties.authInfo AuthInfoBase:

Type d’authentification.

properties.clientType

clientType

Type de client d’application

properties.configurationInfo

ConfigurationInfo

Informations de connexion consommées par les applications, y compris les secrets, les chaînes de connexion.

properties.provisioningState

string

État d’approvisionnement.

properties.publicNetworkSolution

PublicNetworkSolution

Solution réseau.

properties.scope

string

étendue de connexion dans le service source.

properties.secretStore

SecretStore

Option permettant de stocker la valeur secrète en lieu sécurisé

properties.targetService TargetServiceBase:

Propriétés du service cible

properties.vNetSolution

VNetSolution

Solution de réseau virtuel.

LinkerResource

Éditeur de liens de ressource source et cible

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nom de la ressource

properties.authInfo AuthInfoBase:

Type d’authentification.

properties.clientType

clientType

Type de client d’application

properties.configurationInfo

ConfigurationInfo

Informations de connexion consommées par les applications, y compris les secrets, les chaînes de connexion.

properties.provisioningState

string

État d’approvisionnement.

properties.publicNetworkSolution

PublicNetworkSolution

Solution réseau.

properties.scope

string

étendue de connexion dans le service source.

properties.secretStore

SecretStore

Option permettant de stocker la valeur secrète en lieu sécurisé

properties.targetService TargetServiceBase:

Propriétés du service cible

properties.vNetSolution

VNetSolution

Solution de réseau virtuel.

systemData

systemData

Données système.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

PublicNetworkSolution

Indique la solution de réseau public, inclure des règles de pare-feu

Nom Type Description
action

actionType

Optionnel. Indique la solution de réseau public. Si cette option est active, activez l’accès au réseau public du service cible avec le meilleur essai. La valeur par défaut est activée. Si vous optez, désactivez la configuration d’accès au réseau public.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Indique s’il faut nettoyer l’opération précédente (par exemple, les règles de pare-feu) lors de la mise à jour ou de la suppression de Linker

firewallRules

FirewallRules

Décrivez les règles de pare-feu du service cible pour vous assurer que l’application source peut se connecter à la cible.

SecretAuthInfo

Informations d’authentification quand authType est secret

Nom Type Description
authType string:

secret

Type d’authentification.

name

string

Nom d’utilisateur ou nom de compte pour l’authentification secrète.

secretInfo SecretInfoBase:

Mot de passe ou secret du coffre de clés pour l’authentification de secret.

SecretStore

Option permettant de stocker la valeur secrète en lieu sécurisé

Nom Type Description
keyVaultId

string

ID du coffre de clés pour stocker le secret

keyVaultSecretName

string

Nom du secret du coffre de clés pour stocker le secret, valide uniquement lors du stockage d’un secret

SecretType

Type de secret.

Valeur Description
keyVaultSecretReference
keyVaultSecretUri
rawValue

SelfHostedServer

Propriétés du service lorsque le type de service cible est SelfHostedServer

Nom Type Description
endpoint

string

Point de terminaison du service.

type string:

SelfHostedServer

Type de service cible.

ServicePrincipalCertificateAuthInfo

Informations d’authentification quand authType est un certificat servicePrincipal

Nom Type Description
authType string:

servicePrincipalCertificate

Type d’authentification.

certificate

string

Certificat ServicePrincipal pour l’authentification servicePrincipal.

clientId

string

Id client d’application pour l’authentification servicePrincipal.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Indique s’il faut nettoyer l’opération précédente lorsque Linker met à jour ou supprime

principalId

string

ID du principal pour l’authentification servicePrincipal.

roles

string[]

Facultatif, cette valeur spécifie les rôles Azure à attribuer. Automatiquement

ServicePrincipalSecretAuthInfo

Informations d’authentification quand authType est un secret servicePrincipal

Nom Type Description
authType string:

servicePrincipalSecret

Type d’authentification.

clientId

string

ClientId d’application ServicePrincipal pour l’authentification servicePrincipal.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Indique s’il faut nettoyer l’opération précédente lorsque Linker met à jour ou supprime

principalId

string

ID du principal pour l’authentification servicePrincipal.

roles

string[]

Facultatif, cette valeur spécifie les rôles Azure à attribuer. Automatiquement

secret

string

Secret pour l’authentification servicePrincipal.

userName

string

Nom d’utilisateur créé dans la base de données mappée à un utilisateur dans AAD.

SystemAssignedIdentityAuthInfo

Informations d’authentification lorsque authType est systemAssignedIdentity

Nom Type Description
authType string:

systemAssignedIdentity

Type d’authentification.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Indique s’il faut nettoyer l’opération précédente lorsque Linker met à jour ou supprime

roles

string[]

Facultatif, cette valeur spécifie le rôle Azure à attribuer

userName

string

Nom d’utilisateur créé dans la base de données mappée à un utilisateur dans AAD.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string (date-time)

Horodatage de la création de ressources (UTC).

createdBy

string

Identité qui a créé la ressource.

createdByType

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt

string (date-time)

Horodatage de la dernière modification de ressource (UTC)

lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.

UserAccountAuthInfo

Informations d’authentification lorsque authType est le compte d’utilisateur

Nom Type Description
authType string:

userAccount

Type d’authentification.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Indique s’il faut nettoyer l’opération précédente lorsque Linker met à jour ou supprime

principalId

string

ID principal du compte d’utilisateur.

roles

string[]

Facultatif, cette valeur spécifie les rôles Azure à attribuer. Automatiquement

userName

string

Nom d’utilisateur créé dans la base de données mappée à un utilisateur dans AAD.

UserAssignedIdentityAuthInfo

Informations d’authentification lorsque authType est userAssignedIdentity

Nom Type Description
authType string:

userAssignedIdentity

Type d’authentification.

clientId

string

ID client pour userAssignedIdentity.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Indique s’il faut nettoyer l’opération précédente lorsque Linker met à jour ou supprime

roles

string[]

Facultatif, cette valeur spécifie le rôle Azure à attribuer

subscriptionId

string

ID d’abonnement pour userAssignedIdentity.

userName

string

Nom d’utilisateur créé dans la base de données mappée à un utilisateur dans AAD.

ValueSecretInfo

Informations secrètes lorsque le type est rawValue. C’est pour les scénarios que l’utilisateur entre le secret.

Nom Type Description
secretType string:

rawValue

Type de secret.

value

string

Valeur réelle du secret.

VNetSolution

Solution de réseau virtuel pour l’éditeur de liens

Nom Type Description
deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Indique s’il faut nettoyer l’opération précédente lorsque Linker met à jour ou supprime

type

vNetSolutionType

Type de solution de réseau virtuel.

vNetSolutionType

Type de solution de réseau virtuel.

Valeur Description
privateLink
serviceEndpoint