---
title: "PATCH /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}"
method: PATCH
path: "/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}"
tags: ["Linker"]
---

# PATCH /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}

`PATCH /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}`

Operation to update an existing Linker.

## Path parameters

- `resourceUri` string, required
- `linkerName` string, required

## Parameters

- `../../../../../../common-types/resource-management/v3/types.json#/components/parameters/ApiVersionParameter` — unresolved $ref

## Request body

- LinkerPatch — A Linker to be updated.
  - `properties` LinkerProperties — The properties of the Linker.
    - `targetService` TargetServiceBase — The target service properties
      - `type` 'AzureResource' | 'ConfluentBootstrapServer' | 'ConfluentSchemaRegistry' | 'SelfHostedServer' | 'FabricPlatform', required — The target service type.
    - `authInfo` AuthInfoBase — The authentication info
      - `authType` 'systemAssignedIdentity' | 'userAssignedIdentity' | 'servicePrincipalSecret' | 'servicePrincipalCertificate' | 'secret' | 'accessKey' | 'userAccount' | 'easyAuthMicrosoftEntraID', required — The authentication type.
      - `authMode` 'optInAllAuth' | 'optOutAllAuth' — Indicates how to apply the authentication configuration operations.
    - `clientType` 'none' | 'dotnet' | 'java' | 'python' | 'go' | 'php' | 'ruby' | 'django' | 'nodejs' | 'springBoot' | 'kafka-springBoot' | 'jms-springBoot' | 'dapr' — The application client type
    - `provisioningState` string — The provisioning state.
    - `vNetSolution` VNetSolution — The VNet solution for linker
      - `type` 'serviceEndpoint' | 'privateLink' — Type of VNet solution.
      - `deleteOrUpdateBehavior` 'Default' | 'ForcedCleanup' — The cleanup behavior to indicate whether clean up operation when resource is deleted or updated
    - `secretStore` SecretStore — An option to store secret value in secure place
      - `keyVaultId` string, nullable — The key vault id to store secret
      - `keyVaultSecretName` string, nullable — The key vault secret name to store secret, only valid when storing one secret
    - `scope` string, nullable — connection scope in source service.
    - `publicNetworkSolution` PublicNetworkSolution — Indicates public network solution, include firewall rules
      - `deleteOrUpdateBehavior` 'Default' | 'ForcedCleanup' — The cleanup behavior to indicate whether clean up operation when resource is deleted or updated
      - `action` 'enable' | 'optOut'
      - `firewallRules` FirewallRules — Target service's firewall rules. to allow connections from source service.
        - `ipRanges` string[] — This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account.
        - `azureServices` 'true' | 'false' — Whether to allow firewall rules.
        - `callerClientIP` 'true' | 'false' — Whether to allow firewall rules.
    - `configurationInfo` ConfigurationInfo — The configuration information, used to generate configurations or save to applications
      - `deleteOrUpdateBehavior` 'Default' | 'ForcedCleanup' — The cleanup behavior to indicate whether clean up operation when resource is deleted or updated
      - `action` 'enable' | 'optOut'
      - `customizedKeys` object — Optional. A dictionary of default key name and customized key name mapping. If not specified, default key name will be used for generate configurations
      - `daprProperties` DaprProperties — Indicates some additional properties for dapr client type
        - `version` string, nullable — The dapr component version
        - `componentType` string, nullable — The dapr component type
        - `secretStoreComponent` string, nullable — The name of a secret store dapr to retrieve secret
        - `metadata` DaprMetadata[] — Additional dapr metadata
          - `name` string — Metadata property name.
          - `value` string — Metadata property value.
          - `secretRef` string — The secret name where dapr could get value
          - `description` string — The description of the metadata, returned from configuration api
          - `required` 'true' | 'false' — The value indicating whether the metadata is required or not
        - `scopes` string[] — The dapr component scopes
        - `runtimeVersion` string, nullable — The runtime version supported by the properties
        - `bindingComponentDirection` 'input' | 'output' — The direction supported by the dapr binding component
      - `additionalConfigurations` object — A dictionary of additional configurations to be added. Service will auto generate a set of basic configurations and this property is to full fill more customized configurations
      - `additionalConnectionStringProperties` object — A dictionary of additional properties to be added in the end of connection string.
      - `configurationStore` ConfigurationStore — An option to store configuration into different place
        - `appConfigurationId` string, nullable — The app configuration id to store configuration

## Response `200`

Azure operation completed successfully.

- LinkerResource — unresolved $ref

## Other responses

- `201` — Resource 'LinkerResource' create operation succeeded
- `default` — An unexpected error response.

---

[API](https://skmtc.net/azure/apis/servicelinker-microsoft-servicelinker-servicelinker.md) · [All operations](https://skmtc.net/azure/apis/servicelinker-microsoft-servicelinker-servicelinker/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/servicelinker-microsoft-servicelinker-servicelinker/revisions/f0fe037df354/schema)