Linker - Create Or Update

Creare o aggiornare la risorsa del linker.

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

Parametri dell'URI

Name In Required Type Description
linkerName
path True
  • string

Risorsa linker del nome.

resourceUri
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

Name Type Description
properties.authInfo AuthInfoBase:

Tipo di autenticazione.

properties.clientType

Tipo di client dell'applicazione

properties.secretStore

Opzione per archiviare il valore del segreto in una posizione sicura

properties.targetId
  • string

ID risorsa del servizio di destinazione.

properties.vNetSolution

Soluzione di rete virtuale.

Risposte

Name Type Description
200 OK

Successo.

201 Created

Operazione a esecuzione prolungata.

Other Status Codes

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

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 rappresentare l'account utente

Esempio

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"
  }
}

Definizioni

AuthType

Tipo di autenticazione.

clientType

Tipo di client dell'applicazione

createdByType

Tipo di identità che ha creato la risorsa.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta di errore

LinkerResource

Linker della risorsa di origine e di destinazione

SecretAuthInfo

Informazioni di autenticazione quando authType è segreto

SecretStore

Opzione per archiviare il valore del segreto in una posizione sicura

ServicePrincipalCertificateAuthInfo

Informazioni di autenticazione quando authType è un certificato servicePrincipal

ServicePrincipalSecretAuthInfo

Informazioni di autenticazione quando authType è un segreto servicePrincipal

SystemAssignedIdentityAuthInfo

Informazioni di autenticazione quando authType è systemAssignedIdentity

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

UserAssignedIdentityAuthInfo

Informazioni di autenticazione quando authType è userAssignedIdentity

VNetSolution

Soluzione di rete virtuale per il linker

vNetSolutionType

Tipo di soluzione di rete virtuale.

AuthType

Tipo di autenticazione.

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

clientType

Tipo di client dell'applicazione

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

createdByType

Tipo di identità che ha creato la risorsa.

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

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Name Type Description
info
  • object

Informazioni aggiuntive.

type
  • string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Name Type Description
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

Name Type Description
error

Oggetto error.

LinkerResource

Linker della risorsa di origine e di destinazione

Name Type Description
id
  • string

ID di risorsa completo per la risorsa. Ad esempio - /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.provisioningState
  • string

Stato del provisioning.

properties.secretStore

Opzione per archiviare il valore del segreto in una posizione sicura

properties.targetId
  • string

ID risorsa del servizio di destinazione.

properties.vNetSolution

Soluzione di rete virtuale.

systemData

Dati di sistema.

type
  • string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft. Archiviazione/storageAccounts"

SecretAuthInfo

Informazioni di autenticazione quando authType è segreto

Name Type Description
authType string:
  • secret

Tipo di autenticazione.

name
  • string

Nome utente o nome account per l'autenticazione privata.

secret
  • string

Password o chiave dell'account per l'autenticazione privata.

SecretStore

Opzione per archiviare il valore del segreto in una posizione sicura

Name Type Description
keyVaultId
  • string

ID dell'insieme di credenziali delle chiavi per archiviare il segreto

ServicePrincipalCertificateAuthInfo

Informazioni di autenticazione quando authType è un certificato servicePrincipal

Name Type Description
authType string:
  • servicePrincipalCertificate

Tipo di autenticazione.

certificate
  • string

Certificato ServicePrincipal per l'autenticazione servicePrincipal.

clientId
  • string

Application clientId per l'autenticazione servicePrincipal.

principalId
  • string

ID entità per l'autenticazione servicePrincipal.

ServicePrincipalSecretAuthInfo

Informazioni di autenticazione quando authType è un segreto servicePrincipal

Name Type Description
authType string:
  • servicePrincipalSecret

Tipo di autenticazione.

clientId
  • string

ServicePrincipal application clientId per l'autenticazione servicePrincipal.

principalId
  • string

ID entità per l'autenticazione servicePrincipal.

secret
  • string

Segreto per l'autenticazione servicePrincipal.

SystemAssignedIdentityAuthInfo

Informazioni di autenticazione quando authType è systemAssignedIdentity

Name Type Description
authType string:
  • systemAssignedIdentity

Tipo di autenticazione.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Name Type Description
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 volta la risorsa.

lastModifiedByType

Tipo di identità che ha modificato l'ultima volta la risorsa.

UserAssignedIdentityAuthInfo

Informazioni di autenticazione quando authType è userAssignedIdentity

Name Type Description
authType string:
  • userAssignedIdentity

Tipo di autenticazione.

clientId
  • string

ID client per userAssignedIdentity.

subscriptionId
  • string

ID sottoscrizione per userAssignedIdentity.

VNetSolution

Soluzione di rete virtuale per il linker

Name Type Description
type

Tipo di soluzione di rete virtuale.

vNetSolutionType

Tipo di soluzione di rete virtuale.

Name Type Description
privateLink
  • string
serviceEndpoint
  • string