Linker - Create Or Update

Créez ou mettez à jour la ressource de l’éditeur de liens.

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

Paramètres URI

Name In Required Type Description
linkerName
path True
  • string

Ressource Linker de nom.

resourceUri
path True
  • string

Identificateur Azure Resource Manager complet de la ressource à connecter.

api-version
query True
  • string

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

Corps de la demande

Name Type Description
properties.authInfo AuthInfoBase:

Type d’authentification.

properties.clientType

Type de client d’application

properties.secretStore

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

properties.targetId
  • string

ID de ressource du service cible.

properties.vNetSolution

Solution de réseau virtuel.

Réponses

Name Type Description
200 OK

Réussi.

201 Created

Opération de longue durée.

Other Status Codes

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation emprunt d’identité de votre compte d’utilisateur

Exemples

PutLink
PutLinkWithServiceEndpoint

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=2021-11-01-preview

{
  "properties": {
    "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db",
    "authInfo": {
      "authType": "secret",
      "name": "name",
      "secret": "secret"
    }
  }
}

Sample Response

{
  "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": "secret",
      "name": "name"
    },
    "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
  }
}
{
  "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": "secret",
      "name": "name"
    },
    "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
  }
}

PutLinkWithServiceEndpoint

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=2021-11-01-preview

{
  "properties": {
    "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db",
    "authInfo": {
      "authType": "secret",
      "name": "name",
      "secret": "secret"
    },
    "vNetSolution": {
      "type": "serviceEndpoint"
    },
    "secretStore": {
      "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv"
    }
  }
}

Sample Response

{
  "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": "secret",
      "name": "name"
    },
    "vNetSolution": {
      "type": "serviceEndpoint"
    },
    "secretStore": {
      "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv"
    },
    "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
  }
}
{
  "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": "secret",
      "name": "name"
    },
    "vNetSolution": {
      "type": "serviceEndpoint"
    },
    "secretStore": {
      "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv"
    },
    "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
  }
}

Définitions

AuthType

Type d’authentification.

clientType

Type de client d’application

createdByType

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

ErrorAdditionalInfo

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

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

LinkerResource

Éditeur de liens de la ressource source et cible

SecretAuthInfo

Informations d’authentification lorsque l’authType est secret

SecretStore

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

ServicePrincipalCertificateAuthInfo

Informations d’authentification lorsque l’authentification est un certificat servicePrincipal

ServicePrincipalSecretAuthInfo

Informations d’authentification lorsque l’authType est un secret servicePrincipal

SystemAssignedIdentityAuthInfo

Informations d’authentification quand authType est systemAssignedIdentity

systemData

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

UserAssignedIdentityAuthInfo

Informations d’authentification quand authType est userAssignedIdentity

VNetSolution

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

vNetSolutionType

Type de solution de réseau virtuel.

AuthType

Type d’authentification.

Name Type Description
secret
  • string
servicePrincipalCertificate
  • string
servicePrincipalSecret
  • string
systemAssignedIdentity
  • string
userAssignedIdentity
  • string

clientType

Type de client d’application

Name Type Description
django
  • string
dotnet
  • string
go
  • string
java
  • string
nodejs
  • string
none
  • string
php
  • string
python
  • string
ruby
  • string
springBoot
  • string

createdByType

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

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorAdditionalInfo

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

Name Type Description
info
  • object

Informations supplémentaires.

type
  • string

Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Name Type Description
additionalInfo

Informations supplémentaires sur l’erreur.

code
  • string

Code d'erreur.

details

Détails de l’erreur.

message
  • string

Message d’erreur.

target
  • string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Name Type Description
error

Objet d’erreur.

LinkerResource

Éditeur de liens de la ressource source et cible

Name 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

Type de client d’application

properties.provisioningState
  • string

État d’approvisionnement.

properties.secretStore

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

properties.targetId
  • string

ID de ressource du service cible.

properties.vNetSolution

Solution de réseau virtuel.

systemData

Données système.

type
  • string

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

SecretAuthInfo

Informations d’authentification lorsque l’authType est secret

Name Type Description
authType string:
  • secret

Type d’authentification.

name
  • string

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

secret
  • string

Clé de mot de passe ou de compte pour l’authentification secrète.

SecretStore

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

Name Type Description
keyVaultId
  • string

ID du coffre de clés pour stocker le secret

ServicePrincipalCertificateAuthInfo

Informations d’authentification lorsque l’authentification est un certificat servicePrincipal

Name Type Description
authType string:
  • servicePrincipalCertificate

Type d’authentification.

certificate
  • string

Certificat ServicePrincipal pour l’authentification servicePrincipal.

clientId
  • string

ClientId d’application pour l’authentification servicePrincipal.

principalId
  • string

ID du principal pour l’authentification servicePrincipal.

ServicePrincipalSecretAuthInfo

Informations d’authentification lorsque l’authType est un secret servicePrincipal

Name Type Description
authType string:
  • servicePrincipalSecret

Type d’authentification.

clientId
  • string

Client d’application ServicePrincipal pour l’authentification servicePrincipal.

principalId
  • string

ID du principal pour l’authentification servicePrincipal.

secret
  • string

Secret pour l’authentification servicePrincipal.

SystemAssignedIdentityAuthInfo

Informations d’authentification quand authType est systemAssignedIdentity

Name Type Description
authType string:
  • systemAssignedIdentity

Type d’authentification.

systemData

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

Name Type Description
createdAt
  • string

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

createdBy
  • string

Identité qui a créé la ressource.

createdByType

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

lastModifiedAt
  • string

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

lastModifiedBy
  • string

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

lastModifiedByType

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

UserAssignedIdentityAuthInfo

Informations d’authentification quand authType est userAssignedIdentity

Name Type Description
authType string:
  • userAssignedIdentity

Type d’authentification.

clientId
  • string

ID client pour userAssignedIdentity.

subscriptionId
  • string

ID d’abonnement pour userAssignedIdentity.

VNetSolution

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

Name Type Description
type

Type de solution de réseau virtuel.

vNetSolutionType

Type de solution de réseau virtuel.

Name Type Description
privateLink
  • string
serviceEndpoint
  • string