次の方法で共有


Linker - Create Or Update

リンカー リソースを作成または更新します。

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

URI パラメーター

名前 / 必須 説明
linkerName
path True

string

リンカー リソースという名前。

resourceUri
path True

string

接続するリソースの完全修飾 Azure Resource Manager 識別子。

api-version
query True

string

この操作に使用する API バージョン。

要求本文

名前 説明
properties.authInfo AuthInfoBase:

認証の種類。

properties.clientType

clientType

アプリケーション クライアントの種類

properties.configurationInfo

ConfigurationInfo

シークレット、接続文字列など、アプリケーションによって使用される接続情報。

properties.publicNetworkSolution

PublicNetworkSolution

ネットワーク ソリューション。

properties.scope

string

ソース サービスの接続スコープ。

properties.secretStore

SecretStore

シークレット値を安全な場所に格納するオプション

properties.targetService TargetServiceBase:

ターゲット サービスのプロパティ

properties.vNetSolution

VNetSolution

VNet ソリューション。

応答

名前 説明
200 OK

LinkerResource

成功。

201 Created

LinkerResource

実行時間の長い操作。

Other Status Codes

ErrorResponse

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

PutLinker

要求のサンプル

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

{
  "properties": {
    "targetService": {
      "type": "AzureResource",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db"
    },
    "vNetSolution": {
      "type": "serviceEndpoint"
    },
    "authInfo": {
      "authType": "secret",
      "name": "name",
      "secretInfo": {
        "secretType": "rawValue",
        "value": "secret"
      }
    }
  }
}

応答のサンプル

{
  "type": "Microsoft.ServiceLinker/links",
  "name": "linkName",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName",
  "properties": {
    "authInfo": {
      "authType": "secret",
      "name": "name"
    },
    "vNetSolution": {
      "type": "serviceEndpoint"
    },
    "targetService": {
      "type": "AzureResource",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db"
    }
  }
}
{
  "type": "Microsoft.ServiceLinker/links",
  "name": "linkName",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName",
  "properties": {
    "authInfo": {
      "authType": "secret",
      "name": "name"
    },
    "vNetSolution": {
      "type": "serviceEndpoint"
    },
    "targetService": {
      "type": "AzureResource",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db"
    }
  }
}

定義

名前 説明
AccessKeyInfoBase

ターゲット リソース のプロパティから直接アクセス キーを取得します。ターゲット サービスは Azure Resource (Microsoft.Storage など) です

accessKeyPermissions

accessKey のアクセス許可。 ReadWrite は Azure Cosmos DB と Azure App Configuration 用でありManageListenSend Azure Event Hub と Azure Service Bus 用です。

actionType

省略可能。 パブリック ネットワーク ソリューションを示します。 有効にした場合は、最適な方法でターゲット サービスのパブリック ネットワーク アクセスを有効にします。 既定値は enable です。 optOut の場合は、パブリック ネットワーク アクセス構成をオプトアウトします。

allowType

True の場合、Azure サービスがターゲット サービスにアクセスできるようにします。

AuthType

認証の種類。

AzureKeyVaultProperties

型が Azure Key Vault の場合のリソース プロパティ

AzureResource

ターゲット サービスの種類が AzureResource の場合の Azure リソース情報

clientType

アプリケーション クライアントの種類

ConfigurationInfo

構成の生成またはアプリケーションへの保存に使用される構成情報

ConfluentBootstrapServer

ターゲット サービスの種類が ConfluentBootstrapServer の場合のサービス プロパティ

ConfluentSchemaRegistry

ターゲット サービスの種類が ConfluentSchemaRegistry の場合のサービス プロパティ

createdByType

リソースを作成した ID の種類。

DaprMetadata

dapr コンポーネントのメタデータ。

DaprProperties

dapr クライアントの種類に関するいくつかの追加のプロパティを示します

DeleteOrUpdateBehavior

リソースが削除または更新されたときにクリーン操作を実行するかどうかを示すクリーンアップ動作

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

FirewallRules

ターゲット サービスのファイアウォール規則。 ソース サービスからの接続を許可する場合は 。

KeyVaultSecretReferenceSecretInfo

型が keyVaultSecretReference の場合のシークレット情報。 これは、ユーザーがユーザーの keyvault に格納されているシークレットを提供し、ソースが Azure Kubernetes であるシナリオ用です。 Key Vault のリソース ID は secretStore.keyVaultId にリンクされています。

KeyVaultSecretUriSecretInfo

型が keyVaultSecretUri の場合のシークレット情報。 これは、ユーザーがユーザーの keyvault に格納されているシークレットを提供し、ソースが Web アプリ、Spring Cloud、または Container App であるシナリオ用です。

LinkerResource

ソース リソースとターゲット リソースのリンカー

PublicNetworkSolution

パブリック ネットワーク ソリューションを示し、ファイアウォール規則を含めます

SecretAuthInfo

authType がシークレットの場合の認証情報

SecretStore

シークレット値を安全な場所に格納するオプション

SecretType

シークレットの種類。

SelfHostedServer

ターゲット サービスの種類が SelfHostedServer の場合のサービス プロパティ

ServicePrincipalCertificateAuthInfo

authType が servicePrincipal 証明書の場合の認証情報

ServicePrincipalSecretAuthInfo

authType が servicePrincipal シークレットの場合の認証情報

SystemAssignedIdentityAuthInfo

authType が systemAssignedIdentity の場合の認証情報

systemData

リソースの作成と最後の変更に関連するメタデータ。

UserAccountAuthInfo

authType がユーザー アカウントの場合の認証情報

UserAssignedIdentityAuthInfo

authType が userAssignedIdentity の場合の認証情報

ValueSecretInfo

型が rawValue の場合のシークレット情報。 これは、ユーザーがシークレットを入力するシナリオ用です。

VNetSolution

リンカー用の VNet ソリューション

vNetSolutionType

VNet ソリューションの種類。

AccessKeyInfoBase

ターゲット リソース のプロパティから直接アクセス キーを取得します。ターゲット サービスは Azure Resource (Microsoft.Storage など) です

名前 説明
authType string:

accessKey

認証の種類。

permissions

accessKeyPermissions[]

accessKey のアクセス許可。 ReadWrite は Azure Cosmos DB と Azure App Configuration 用でありManageListenSend Azure Event Hub と Azure Service Bus 用です。

accessKeyPermissions

accessKey のアクセス許可。 ReadWrite は Azure Cosmos DB と Azure App Configuration 用でありManageListenSend Azure Event Hub と Azure Service Bus 用です。

名前 説明
Listen

string

Manage

string

Read

string

Send

string

Write

string

actionType

省略可能。 パブリック ネットワーク ソリューションを示します。 有効にした場合は、最適な方法でターゲット サービスのパブリック ネットワーク アクセスを有効にします。 既定値は enable です。 optOut の場合は、パブリック ネットワーク アクセス構成をオプトアウトします。

名前 説明
enable

string

optOut

string

allowType

True の場合、Azure サービスがターゲット サービスにアクセスできるようにします。

名前 説明
false

string

true

string

AuthType

認証の種類。

名前 説明
accessKey

string

secret

string

servicePrincipalCertificate

string

servicePrincipalSecret

string

systemAssignedIdentity

string

userAccount

string

userAssignedIdentity

string

AzureKeyVaultProperties

型が Azure Key Vault の場合のリソース プロパティ

名前 説明
connectAsKubernetesCsiDriver

boolean

True を指定すると、Kubernetes CSI ドライバー経由で接続します。

type string:

KeyVault

Azure リソースの種類。

AzureResource

ターゲット サービスの種類が AzureResource の場合の Azure リソース情報

名前 説明
id

string

Azure リソースの ID。

resourceProperties AzureResourcePropertiesBase:

AzureKeyVaultProperties

Azure リソース接続関連のプロパティ。

type string:

AzureResource

ターゲット サービスの種類。

clientType

アプリケーション クライアントの種類

名前 説明
dapr

string

django

string

dotnet

string

go

string

java

string

kafka-springBoot

string

nodejs

string

none

string

php

string

python

string

ruby

string

springBoot

string

ConfigurationInfo

構成の生成またはアプリケーションへの保存に使用される構成情報

名前 説明
action

actionType

オプション。ソース アプリケーションに構成を適用するかどうかを指定します。 有効にした場合は、構成を生成し、ソース アプリケーションに適用します。 既定値は有効です。 optOut の場合、ソースに対する構成変更は行われません。

additionalConfigurations

object

追加する追加の構成のディクショナリ。 サービスは一連の基本的な構成を自動生成します。このプロパティは、よりカスタマイズされた構成を完全に入力することです

customizedKeys

object

省略可能。 既定のキー名とカスタマイズされたキー名マッピングのディクショナリ。 指定しない場合、既定のキー名は構成の生成に使用されます

daprProperties

DaprProperties

dapr クライアントの種類に関するいくつかの追加のプロパティを示します

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

リンカーが更新または削除するときに、前の操作をクリーンするかどうかを示します

ConfluentBootstrapServer

ターゲット サービスの種類が ConfluentBootstrapServer の場合のサービス プロパティ

名前 説明
endpoint

string

サービスのエンドポイント。

type string:

ConfluentBootstrapServer

ターゲット サービスの種類。

ConfluentSchemaRegistry

ターゲット サービスの種類が ConfluentSchemaRegistry の場合のサービス プロパティ

名前 説明
endpoint

string

サービスのエンドポイント。

type string:

ConfluentSchemaRegistry

ターゲット サービスの種類。

createdByType

リソースを作成した ID の種類。

名前 説明
Application

string

Key

string

ManagedIdentity

string

User

string

DaprMetadata

dapr コンポーネントのメタデータ。

名前 説明
name

string

メタデータ プロパティ名。

secretRef

string

dapr が値を取得できるシークレット名

value

string

メタデータ プロパティ値。

DaprProperties

dapr クライアントの種類に関するいくつかの追加のプロパティを示します

名前 説明
componentType

string

dapr コンポーネントの種類

metadata

DaprMetadata[]

追加の dapr メタデータ

scopes

string[]

dapr コンポーネントのスコープ

secretStoreComponent

string

シークレットを取得するシークレット ストア dapr の名前

version

string

dapr コンポーネントのバージョン

DeleteOrUpdateBehavior

リソースが削除または更新されたときにクリーン操作を実行するかどうかを示すクリーンアップ動作

名前 説明
Default

string

ForcedCleanup

string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

error オブジェクト。

FirewallRules

ターゲット サービスのファイアウォール規則。 ソース サービスからの接続を許可する場合は 。

名前 説明
azureServices

allowType

True の場合、Azure サービスがターゲット サービスにアクセスできるようにします。

callerClientIP

allowType

true の場合、呼び出し元クライアント IP がターゲット サービスにアクセスできるようにします。 プロパティは、ローカル アプリケーションをターゲット サービスに接続するときに使用されます。

ipRanges

string[]

この値は、特定のデータベース アカウントのクライアント IP の許可リストとして含める IP アドレスまたは IP アドレス範囲のセットを CIDR 形式で指定します。

KeyVaultSecretReferenceSecretInfo

型が keyVaultSecretReference の場合のシークレット情報。 これは、ユーザーがユーザーの keyvault に格納されているシークレットを提供し、ソースが Azure Kubernetes であるシナリオ用です。 Key Vault のリソース ID は secretStore.keyVaultId にリンクされています。

名前 説明
name

string

Key Vault シークレットの名前。

secretType string:

keyVaultSecretReference

シークレットの種類。

version

string

Key Vault シークレットのバージョン。

KeyVaultSecretUriSecretInfo

型が keyVaultSecretUri の場合のシークレット情報。 これは、ユーザーがユーザーの keyvault に格納されているシークレットを提供し、ソースが Web アプリ、Spring Cloud、または Container App であるシナリオ用です。

名前 説明
secretType string:

keyVaultSecretUri

シークレットの種類。

value

string

keyvault シークレットへの URI

LinkerResource

ソース リソースとターゲット リソースのリンカー

名前 説明
id

string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

リソースの名前

properties.authInfo AuthInfoBase:

認証の種類。

properties.clientType

clientType

アプリケーション クライアントの種類

properties.configurationInfo

ConfigurationInfo

シークレット、接続文字列など、アプリケーションによって使用される接続情報。

properties.provisioningState

string

プロビジョニングの状態。

properties.publicNetworkSolution

PublicNetworkSolution

ネットワーク ソリューション。

properties.scope

string

ソース サービスの接続スコープ。

properties.secretStore

SecretStore

シークレット値を安全な場所に格納するオプション

properties.targetService TargetServiceBase:

ターゲット サービスのプロパティ

properties.vNetSolution

VNetSolution

VNet ソリューション。

systemData

systemData

システム データ。

type

string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

PublicNetworkSolution

パブリック ネットワーク ソリューションを示し、ファイアウォール規則を含めます

名前 説明
action

actionType

省略可能。 パブリック ネットワーク ソリューションを示します。 有効にした場合は、最適な試みでターゲット サービスのパブリック ネットワーク アクセスを有効にします。 既定値は有効です。 optOut の場合は、パブリック ネットワーク アクセスの構成をオプトアウトします。

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

リンカーの更新または削除時に、前の操作 (ファイアウォール規則など) をクリーンするかどうかを示します

firewallRules

FirewallRules

ソース アプリケーションがターゲットに接続できることを確認するために、ターゲット サービスのファイアウォール規則について説明します。

SecretAuthInfo

authType がシークレットの場合の認証情報

名前 説明
authType string:

secret

認証の種類。

name

string

シークレット認証のユーザー名またはアカウント名。

secretInfo SecretInfoBase:

シークレット認証用のパスワードまたはキー コンテナー シークレット。

SecretStore

シークレット値を安全な場所に格納するオプション

名前 説明
keyVaultId

string

シークレットを格納するキー コンテナー ID

keyVaultSecretName

string

シークレットを格納するキー コンテナーシークレット名。1 つのシークレットを格納する場合にのみ有効です

SecretType

シークレットの種類。

名前 説明
keyVaultSecretReference

string

keyVaultSecretUri

string

rawValue

string

SelfHostedServer

ターゲット サービスの種類が SelfHostedServer の場合のサービス プロパティ

名前 説明
endpoint

string

サービスのエンドポイント。

type string:

SelfHostedServer

ターゲット サービスの種類。

ServicePrincipalCertificateAuthInfo

authType が servicePrincipal 証明書の場合の認証情報

名前 説明
authType string:

servicePrincipalCertificate

認証の種類。

certificate

string

servicePrincipal 認証の ServicePrincipal 証明書。

clientId

string

servicePrincipal 認証の Application clientId。

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

リンカーが更新または削除するときに、前の操作をクリーンするかどうかを示します

principalId

string

servicePrincipal 認証のプリンシパル ID。

roles

string[]

省略可能。この値は、割り当てる Azure ロールを指定します。 [自動]

ServicePrincipalSecretAuthInfo

authType が servicePrincipal シークレットの場合の認証情報

名前 説明
authType string:

servicePrincipalSecret

認証の種類。

clientId

string

servicePrincipal 認証の ServicePrincipal アプリケーション clientId。

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

リンカーが更新または削除するときに、前の操作をクリーンするかどうかを示します

principalId

string

servicePrincipal 認証のプリンシパル ID。

roles

string[]

省略可能。この値は、割り当てる Azure ロールを指定します。 [自動]

secret

string

servicePrincipal 認証のシークレット。

userName

string

AAD のユーザーにマップされるデータベースで作成されたユーザー名。

SystemAssignedIdentityAuthInfo

authType が systemAssignedIdentity の場合の認証情報

名前 説明
authType string:

systemAssignedIdentity

認証の種類。

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

リンカーが更新または削除するときに、前の操作をクリーンするかどうかを示します

roles

string[]

省略可能。この値は、割り当てる Azure ロールを指定します

userName

string

AAD のユーザーにマップされるデータベースで作成されたユーザー名。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前 説明
createdAt

string

リソース作成のタイムスタンプ (UTC)。

createdBy

string

リソースを作成した ID。

createdByType

createdByType

リソースを作成した ID の種類。

lastModifiedAt

string

リソースの最終変更のタイムスタンプ (UTC)

lastModifiedBy

string

リソースを最後に変更した ID。

lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。

UserAccountAuthInfo

authType がユーザー アカウントの場合の認証情報

名前 説明
authType string:

userAccount

認証の種類。

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

リンカーを更新または削除するときに、前の操作をクリーンするかどうかを示します

principalId

string

ユーザー アカウントのプリンシパル ID。

roles

string[]

省略可能。この値は、割り当てる Azure ロールを指定します。 [自動]

userName

string

AAD のユーザーにマップされるデータベースで作成されたユーザー名。

UserAssignedIdentityAuthInfo

authType が userAssignedIdentity の場合の認証情報

名前 説明
authType string:

userAssignedIdentity

認証の種類。

clientId

string

userAssignedIdentity のクライアント ID。

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

リンカーが更新または削除するときに、前の操作をクリーンするかどうかを示します

roles

string[]

省略可能。この値は、割り当てる Azure ロールを指定します

subscriptionId

string

userAssignedIdentity のサブスクリプション ID。

userName

string

AAD のユーザーにマップされるデータベースで作成されたユーザー名。

ValueSecretInfo

型が rawValue の場合のシークレット情報。 これは、ユーザーがシークレットを入力するシナリオ用です。

名前 説明
secretType string:

rawValue

シークレットの種類。

value

string

シークレットの実際の値。

VNetSolution

リンカー用の VNet ソリューション

名前 説明
deleteOrUpdateBehavior

DeleteOrUpdateBehavior

リンカーが更新または削除するときに、前の操作をクリーンするかどうかを示します

type

vNetSolutionType

VNet ソリューションの種類。

vNetSolutionType

VNet ソリューションの種類。

名前 説明
privateLink

string

serviceEndpoint

string