Linker - Create Or Update

Membuat atau memperbarui sumber daya linker.

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

Parameter URI

Name In Required Type Description
linkerName
path True
  • string

Nama sumber daya Linker.

resourceUri
path True
  • string

Pengidentifikasi Azure Resource manager yang sepenuhnya memenuhi syarat dari sumber daya yang akan disambungkan.

api-version
query True
  • string

Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Name Type Description
properties.authInfo AuthInfoBase:

Jenis Autentikasi.

properties.clientType

Jenis klien aplikasi

properties.secretStore

Opsi untuk menyimpan nilai rahasia di tempat yang aman

properties.targetId
  • string

Id sumber daya layanan target.

properties.vNetSolution

Solusi VNet.

Respons

Name Type Description
200 OK

Sukses.

201 Created

Operasi jangka panjang.

Other Status Codes

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

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 meniru akun pengguna Anda

Contoh

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

Definisi

AuthType

Jenis Autentikasi.

clientType

Jenis klien aplikasi

createdByType

Jenis identitas yang membuat sumber daya.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

ErrorDetail

Detail kesalahan.

ErrorResponse

Respons kesalahan

LinkerResource

Linker sumber daya sumber dan target

SecretAuthInfo

Info autentikasi saat authType rahasia

SecretStore

Opsi untuk menyimpan nilai rahasia di tempat yang aman

ServicePrincipalCertificateAuthInfo

Info autentikasi saat authType adalah sertifikat servicePrincipal

ServicePrincipalSecretAuthInfo

Info autentikasi saat authType adalah rahasia servicePrincipal

SystemAssignedIdentityAuthInfo

Info autentikasi saat authType adalah systemAssignedIdentity

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

UserAssignedIdentityAuthInfo

Info autentikasi saat authType adalah userAssignedIdentity

VNetSolution

Solusi VNet untuk linker

vNetSolutionType

Jenis solusi VNet.

AuthType

Jenis Autentikasi.

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

clientType

Jenis klien aplikasi

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

createdByType

Jenis identitas yang membuat sumber daya.

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

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Name Type Description
info
  • object

Info tambahan.

type
  • string

Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Name Type Description
additionalInfo

Info tambahan kesalahan.

code
  • string

Kode kesalahan.

details

Detail kesalahan.

message
  • string

Pesan kesalahan.

target
  • string

Target kesalahan.

ErrorResponse

Respons kesalahan

Name Type Description
error

Objek kesalahan.

LinkerResource

Linker sumber daya sumber dan target

Name Type Description
id
  • string

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Nama sumber daya.

properties.authInfo AuthInfoBase:

Jenis Autentikasi.

properties.clientType

Jenis klien aplikasi

properties.provisioningState
  • string

Status penyediaan.

properties.secretStore

Opsi untuk menyimpan nilai rahasia di tempat yang aman

properties.targetId
  • string

Id sumber daya layanan target.

properties.vNetSolution

Solusi VNet.

systemData

Data sistem.

type
  • string

Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft. Storage/storageAccounts"

SecretAuthInfo

Info autentikasi saat authType rahasia

Name Type Description
authType string:
  • secret

Jenis Autentikasi.

name
  • string

Nama pengguna atau nama akun untuk autentikasi rahasia.

secret
  • string

Kata sandi atau kunci akun untuk autentikasi rahasia.

SecretStore

Opsi untuk menyimpan nilai rahasia di tempat yang aman

Name Type Description
keyVaultId
  • string

Id brankas kunci untuk menyimpan rahasia

ServicePrincipalCertificateAuthInfo

Info autentikasi saat authType adalah sertifikat servicePrincipal

Name Type Description
authType string:
  • servicePrincipalCertificate

Jenis Autentikasi.

certificate
  • string

Sertifikat ServicePrincipal untuk autentikasi servicePrincipal.

clientId
  • string

ClientId aplikasi untuk autentikasi servicePrincipal.

principalId
  • string

Id Utama untuk autentikasi servicePrincipal.

ServicePrincipalSecretAuthInfo

Info autentikasi saat authType adalah rahasia servicePrincipal

Name Type Description
authType string:
  • servicePrincipalSecret

Jenis Autentikasi.

clientId
  • string

ClientId aplikasi ServicePrincipal untuk servicePrincipal auth.

principalId
  • string

Id Utama untuk autentikasi servicePrincipal.

secret
  • string

Rahasia untuk servicePrincipal auth.

SystemAssignedIdentityAuthInfo

Info autentikasi saat authType adalah systemAssignedIdentity

Name Type Description
authType string:
  • systemAssignedIdentity

Jenis Autentikasi.

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Name Type Description
createdAt
  • string

Tanda waktu pembuatan sumber daya (UTC).

createdBy
  • string

Identitas yang membuat sumber daya.

createdByType

Jenis identitas yang membuat sumber daya.

lastModifiedAt
  • string

Tanda waktu modifikasi terakhir sumber daya (UTC)

lastModifiedBy
  • string

Identitas yang terakhir mengubah sumber daya.

lastModifiedByType

Jenis identitas yang terakhir mengubah sumber daya.

UserAssignedIdentityAuthInfo

Info autentikasi saat authType adalah userAssignedIdentity

Name Type Description
authType string:
  • userAssignedIdentity

Jenis Autentikasi.

clientId
  • string

Id Klien untuk userAssignedIdentity.

subscriptionId
  • string

Id langganan untuk userAssignedIdentity.

VNetSolution

Solusi VNet untuk linker

Name Type Description
type

Jenis solusi VNet.

vNetSolutionType

Jenis solusi VNet.

Name Type Description
privateLink
  • string
serviceEndpoint
  • string