Linker - Create Or Update

サービス:: Service Connector

API バージョン:: 2022-11-01-preview

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

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 minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
properties.authInfo	AuthInfoBase: AccessKeyInfoBase SecretAuthInfo UserAssignedIdentityAuthInfo SystemAssignedIdentityAuthInfo ServicePrincipalSecretAuthInfo ServicePrincipalCertificateAuthInfo UserAccountAuthInfo	認証の種類。
properties.clientType	clientType	アプリケーションクライアントの種類
properties.configurationInfo	ConfigurationInfo	シークレット、接続文字列など、アプリケーションによって使用される接続情報。
properties.publicNetworkSolution	PublicNetworkSolution	ネットワークソリューション。
properties.scope	string	ソースサービスの接続スコープ。
properties.secretStore	SecretStore	シークレット値を安全な場所に格納するオプション
properties.targetService	TargetServiceBase: AzureResource ConfluentBootstrapServer SelfHostedServer ConfluentSchemaRegistry	ターゲットサービスのプロパティ
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"
      }
    }
  }
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.servicelinker import ServiceLinkerManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicelinker
# USAGE
    python put_linker.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ServiceLinkerManagementClient(
        credential=DefaultAzureCredential(),
    )

    response = client.linker.begin_create_or_update(
        resource_uri="subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app",
        linker_name="linkName",
        parameters={
            "properties": {
                "authInfo": {
                    "authType": "secret",
                    "name": "name",
                    "secretInfo": {"secretType": "rawValue", "value": "secret"},
                },
                "targetService": {
                    "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db",
                    "type": "AzureResource",
                },
                "vNetSolution": {"type": "serviceEndpoint"},
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2022-11-01-preview/examples/PutLinker.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

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

状態コード:: 201

{
  "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 のアクセス許可。 `Read` と `Write` は Azure Cosmos DB と Azure App Configuration 用であり、`Listen`、`Send`、`Manage` は Azure Event Hub と Azure Service Bus 用です。
actionType	随意。パブリックネットワークソリューションを示します。有効にした場合は、最適な方法でターゲットサービスのパブリックネットワークアクセスを有効にします。既定値は有効です。 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、またはコンテナーアプリであるシナリオ用です。
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

Object

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

名前	型	説明
authType	string: accessKey	認証の種類。
permissions	accessKeyPermissions[]	accessKey のアクセス許可。 `Read` と `Write` は Azure Cosmos DB と Azure App Configuration 用であり、`Listen`、`Send`、`Manage` は Azure Event Hub と Azure Service Bus 用です。

accessKeyPermissions

列挙

accessKey のアクセス許可。 Read と Write は Azure Cosmos DB と Azure App Configuration 用であり、Listen、Send、Manage は Azure Event Hub と Azure Service Bus 用です。

値	説明
Read
Write
Listen
Send
Manage

actionType

列挙

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

値	説明
enable
optOut

allowType

列挙

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

値	説明
true
false

AuthType

列挙

認証の種類。

値	説明
systemAssignedIdentity
userAssignedIdentity
servicePrincipalSecret
servicePrincipalCertificate
secret
accessKey
userAccount

AzureKeyVaultProperties

Object

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

名前	型	説明
connectAsKubernetesCsiDriver	boolean	True Kubernetes CSI ドライバー経由で接続する場合。
type	string: KeyVault	Azure リソースの種類。

AzureResource

Object

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

名前	型	説明
id	string	Azure リソースの ID。
resourceProperties	AzureResourcePropertiesBase: AzureKeyVaultProperties	Azure リソース接続に関連するプロパティ。
type	string: AzureResource	ターゲットサービスの種類。

clientType

列挙

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

値	説明
none
dotnet
java
python
go
php
ruby
django
nodejs
springBoot
kafka-springBoot
dapr

ConfigurationInfo

Object

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

名前	型	説明
action	actionType	オプション。ソースアプリケーションに構成を適用するかどうかを指定します。有効にした場合は、構成を生成し、ソースアプリケーションに適用します。既定値は有効です。 optOut の場合、ソースで構成変更は行われません。
additionalConfigurations	object	追加する追加構成のディクショナリ。サービスは一連の基本的な構成を自動生成します。このプロパティは、よりカスタマイズされた構成を完全に入力することです
customizedKeys	object	随意。既定のキー名とカスタマイズされたキー名マッピングのディクショナリ。指定しない場合、既定のキー名が構成の生成に使用されます
daprProperties	DaprProperties	dapr クライアントの種類に関するいくつかの追加のプロパティを示します
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	リンカーの更新時または削除時に前の操作をクリーンアップするかどうかを示します

ConfluentBootstrapServer

Object

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

名前	型	説明
endpoint	string	サービスのエンドポイント。
type	string: ConfluentBootstrapServer	ターゲットサービスの種類。

ConfluentSchemaRegistry

Object

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

名前	型	説明
endpoint	string	サービスのエンドポイント。
type	string: ConfluentSchemaRegistry	ターゲットサービスの種類。

createdByType

列挙

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

値	説明
User
Application
ManagedIdentity
Key

DaprMetadata

Object

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

名前	型	説明
name	string	メタデータプロパティ名。
secretRef	string	dapr が値を取得できるシークレット名
value	string	メタデータプロパティの値。

DaprProperties

Object

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

名前	型	説明
componentType	string	dapr コンポーネントの種類
metadata	DaprMetadata[]	追加の dapr メタデータ
scopes	string[]	dapr コンポーネントのスコープ
secretStoreComponent	string	シークレットを取得するシークレットストア dapr の名前
version	string	dapr コンポーネントのバージョン

DeleteOrUpdateBehavior

列挙

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

値	説明
Default
ForcedCleanup

ErrorAdditionalInfo

Object

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

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

FirewallRules

Object

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

名前	型	説明
azureServices	allowType	True の場合、Azure サービスがターゲットサービスにアクセスできるようにします。
callerClientIP	allowType	呼び出し元クライアント IP が true の場合、ターゲットサービスへのアクセスを許可します。このプロパティは、ローカルアプリケーションをターゲットサービスに接続するときに使用されます。
ipRanges	string[]	この値は、特定のデータベースアカウントのクライアント IP の許可リストとして含める IP アドレスまたは IP アドレス範囲のセットを CIDR 形式で指定します。

KeyVaultSecretReferenceSecretInfo

Object

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

名前	型	説明
name	string	Key Vault シークレットの名前。
secretType	string: keyVaultSecretReference	シークレットの種類。
version	string	Key Vault シークレットのバージョン。

KeyVaultSecretUriSecretInfo

Object

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

名前	型	説明
secretType	string: keyVaultSecretUri	シークレットの種類。
value	string	keyvault シークレットへの URI

LinkerResource

Object

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

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.authInfo	AuthInfoBase: AccessKeyInfoBase SecretAuthInfo ServicePrincipalCertificateAuthInfo ServicePrincipalSecretAuthInfo SystemAssignedIdentityAuthInfo UserAccountAuthInfo UserAssignedIdentityAuthInfo	認証の種類。
properties.clientType	clientType	アプリケーションクライアントの種類
properties.configurationInfo	ConfigurationInfo	シークレット、接続文字列など、アプリケーションによって使用される接続情報。
properties.provisioningState	string	プロビジョニングの状態。
properties.publicNetworkSolution	PublicNetworkSolution	ネットワークソリューション。
properties.scope	string	ソースサービスの接続スコープ。
properties.secretStore	SecretStore	シークレット値を安全な場所に格納するオプション
properties.targetService	TargetServiceBase: AzureResource ConfluentBootstrapServer ConfluentSchemaRegistry SelfHostedServer	ターゲットサービスのプロパティ
properties.vNetSolution	VNetSolution	VNet ソリューション。
systemData	systemData	システムデータ。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

PublicNetworkSolution

Object

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

名前	型	説明
action	actionType	随意。パブリックネットワークソリューションを示します。有効にした場合は、最適な方法でターゲットサービスのパブリックネットワークアクセスを有効にします。既定値は有効です。 optOut の場合は、パブリックネットワークアクセスの構成をオプトアウトします。
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	リンカーが更新または削除するときに、前の操作 (ファイアウォール規則など) をクリーンアップするかどうかを示します
firewallRules	FirewallRules	ソースアプリケーションがターゲットに接続できることを確認するために、ターゲットサービスのファイアウォール規則について説明します。

SecretAuthInfo

Object

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

名前	型	説明
authType	string: secret	認証の種類。
name	string	シークレット認証のユーザー名またはアカウント名。
secretInfo	SecretInfoBase: KeyVaultSecretReferenceSecretInfo KeyVaultSecretUriSecretInfo ValueSecretInfo	シークレット認証用のパスワードまたはキーコンテナーシークレット。

SecretStore

Object

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

名前	型	説明
keyVaultId	string	シークレットを格納するキーコンテナー ID
keyVaultSecretName	string	シークレットを格納するキーコンテナーシークレット名。1 つのシークレットを格納する場合にのみ有効です

SecretType

列挙

シークレットの種類。

値	説明
rawValue
keyVaultSecretUri
keyVaultSecretReference

SelfHostedServer

Object

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

名前	型	説明
endpoint	string	サービスのエンドポイント。
type	string: SelfHostedServer	ターゲットサービスの種類。

ServicePrincipalCertificateAuthInfo

Object

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

名前	型	説明
authType	string: servicePrincipalCertificate	認証の種類。
certificate	string	servicePrincipal 認証の ServicePrincipal 証明書。
clientId	string	servicePrincipal 認証用の Application clientId。
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	リンカーの更新時または削除時に前の操作をクリーンアップするかどうかを示します
principalId	string	servicePrincipal 認証のプリンシパル ID。
roles	string[]	省略可能。この値は、割り当てる Azure ロールを指定します。自動的に

ServicePrincipalSecretAuthInfo

Object

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

Object

authType が systemAssignedIdentity の場合の認証情報

名前	型	説明
authType	string: systemAssignedIdentity	認証の種類。
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	リンカーの更新時または削除時に前の操作をクリーンアップするかどうかを示します
roles	string[]	省略可能。この値は、割り当てる Azure ロールを指定します
userName	string	AAD 内のユーザーにマップされるデータベースに作成されたユーザー名。

systemData

Object

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

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

UserAccountAuthInfo

Object

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

名前	型	説明
authType	string: userAccount	認証の種類。
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	リンカーの更新時または削除時に前の操作をクリーンアップするかどうかを示します
principalId	string	ユーザーアカウントのプリンシパル ID。
roles	string[]	省略可能。この値は、割り当てる Azure ロールを指定します。自動的に
userName	string	AAD 内のユーザーにマップされるデータベースに作成されたユーザー名。

UserAssignedIdentityAuthInfo

Object

authType が userAssignedIdentity の場合の認証情報

名前	型	説明
authType	string: userAssignedIdentity	認証の種類。
clientId	string	userAssignedIdentity のクライアント ID。
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	リンカーの更新時または削除時に前の操作をクリーンアップするかどうかを示します
roles	string[]	省略可能。この値は、割り当てる Azure ロールを指定します
subscriptionId	string	userAssignedIdentity のサブスクリプション ID。
userName	string	AAD 内のユーザーにマップされるデータベースに作成されたユーザー名。

ValueSecretInfo

Object

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

名前	型	説明
secretType	string: rawValue	シークレットの種類。
value	string	シークレットの実際の値。

VNetSolution

Object

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

名前	型	説明
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	リンカーの更新時または削除時に前の操作をクリーンアップするかどうかを示します
type	vNetSolutionType	VNet ソリューションの種類。

vNetSolutionType

列挙

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

値	説明
serviceEndpoint
privateLink

次の方法で共有

Linker - Create Or Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

PutLinker

要求のサンプル

応答のサンプル

定義

AccessKeyInfoBase

accessKeyPermissions

actionType

allowType

AuthType

AzureKeyVaultProperties

AzureResource

clientType

ConfigurationInfo

ConfluentBootstrapServer

ConfluentSchemaRegistry

createdByType

DaprMetadata

DaprProperties

DeleteOrUpdateBehavior

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FirewallRules

KeyVaultSecretReferenceSecretInfo

KeyVaultSecretUriSecretInfo

LinkerResource

PublicNetworkSolution

SecretAuthInfo

SecretStore

SecretType

SelfHostedServer

ServicePrincipalCertificateAuthInfo

ServicePrincipalSecretAuthInfo

SystemAssignedIdentityAuthInfo

systemData

UserAccountAuthInfo

UserAssignedIdentityAuthInfo

ValueSecretInfo

VNetSolution

vNetSolutionType