Linker - Create Or Update

Vytvořte nebo aktualizujte prostředek linkeru.

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

Parametry identifikátoru URI

Name In Required Type Description
linkerName
path True
  • string

Prostředek Linkeru.

resourceUri
path True
  • string

Plně kvalifikovaný identifikátor Azure Resource Manageru prostředku, který se má připojit.

api-version
query True
  • string

Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name Type Description
properties.authInfo AuthInfoBase:

Typ ověřování.

properties.clientType

Typ klienta aplikace

properties.secretStore

Možnost uložení hodnoty tajného kódu na bezpečném místě

properties.targetId
  • string

ID prostředku cílové služby.

properties.vNetSolution

Řešení virtuální sítě.

Odpovědi

Name Type Description
200 OK

Úspěšné.

201 Created

Dlouhotrvající operace.

Other Status Codes

Odpověď na chybu popisující, proč operace selhala.

Zabezpečení

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 zosobnění uživatelského účtu

Příklady

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

Definice

AuthType

Typ ověřování.

clientType

Typ klienta aplikace

createdByType

Typ identity, která prostředek vytvořila.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorDetail

Podrobnosti o chybě.

ErrorResponse

Chybová odpověď

LinkerResource

Linker zdrojového a cílového prostředku

SecretAuthInfo

Ověřovací informace při tajném kódu authType

SecretStore

Možnost uložení hodnoty tajného kódu na bezpečném místě

ServicePrincipalCertificateAuthInfo

Ověřovací informace, když je typ ověřování servicePrincipal certificate

ServicePrincipalSecretAuthInfo

Ověřovací informace, když je typ ověřování tajný klíč servicePrincipal

SystemAssignedIdentityAuthInfo

Ověřovací informace, pokud je typ ověřování systemAssignedIdentity

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

UserAssignedIdentityAuthInfo

Ověřovací informace, když je typ ověřování userAssignedIdentity

VNetSolution

Řešení virtuální sítě pro linker

vNetSolutionType

Typ řešení virtuální sítě

AuthType

Typ ověřování.

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

clientType

Typ klienta aplikace

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

createdByType

Typ identity, která prostředek vytvořila.

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

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Type Description
info
  • object

Další informace.

type
  • string

Další typ informací.

ErrorDetail

Podrobnosti o chybě.

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

Objekt chyby.

LinkerResource

Linker zdrojového a cílového prostředku

Name Type 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.provisioningState
  • string

Stav zřizování

properties.secretStore

Možnost uložení hodnoty tajného kódu na bezpečném místě

properties.targetId
  • string

ID prostředku 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

SecretAuthInfo

Ověřovací informace při tajném kódu authType

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

secret
  • string

Heslo nebo klíč účtu 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 Type Description
keyVaultId
  • string

ID trezoru klíčů pro uložení tajného kódu

ServicePrincipalCertificateAuthInfo

Ověřovací informace, když je typ ověřování servicePrincipal certificate

Name Type Description
authType string:
  • servicePrincipalCertificate

Typ ověřování.

certificate
  • string

Certifikát ServicePrincipal pro ověřování servicePrincipal

clientId
  • string

Id klienta aplikace pro ověřování servicePrincipal.

principalId
  • string

ID objektu zabezpečení pro ověřování servicePrincipal.

ServicePrincipalSecretAuthInfo

Ověřovací informace, když je typ ověřování tajný klíč servicePrincipal

Name Type Description
authType string:
  • servicePrincipalSecret

Typ ověřování.

clientId
  • string

ServicePrincipal application clientId for servicePrincipal auth.

principalId
  • string

ID objektu zabezpečení pro ověřování servicePrincipal.

secret
  • string

Tajný klíč pro ověřování servicePrincipal.

SystemAssignedIdentityAuthInfo

Ověřovací informace, pokud je typ ověřování systemAssignedIdentity

Name Type Description
authType string:
  • systemAssignedIdentity

Typ ověřování.

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name Type Description
createdAt
  • string

Č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

Časové razítko poslední změny zdroje (UTC)

lastModifiedBy
  • string

Identita, která prostředek naposledy upravila.

lastModifiedByType

Typ identity, která naposledy upravila prostředek.

UserAssignedIdentityAuthInfo

Ověřovací informace, když je typ ověřování userAssignedIdentity

Name Type Description
authType string:
  • userAssignedIdentity

Typ ověřování.

clientId
  • string

ID klienta pro userAssignedIdentity

subscriptionId
  • string

ID předplatného pro userAssignedIdentity

VNetSolution

Řešení virtuální sítě pro linker

Name Type Description
type

Typ řešení virtuální sítě

vNetSolutionType

Typ řešení virtuální sítě

Name Type Description
privateLink
  • string
serviceEndpoint
  • string