Package-level declarations

Types

Link copied to clipboard
data class AccessKeyInfoBaseResponse(val authMode: String? = null, val authType: String, val permissions: List<String>? = null)

The access key directly from target resource properties, which target service is Azure Resource, such as Microsoft.Storage

Link copied to clipboard
data class AzureKeyVaultPropertiesResponse(val connectAsKubernetesCsiDriver: Boolean? = null, val type: String)

The resource properties when type is Azure Key Vault

Link copied to clipboard
data class AzureResourceResponse(val id: String? = null, val resourceProperties: AzureKeyVaultPropertiesResponse? = null, val type: String)

The azure resource info when target service type is AzureResource

data class BasicErrorDryrunPrerequisiteResultResponse(val code: String? = null, val message: String? = null, val type: String)

The represent of basic error

Link copied to clipboard
data class ConfigurationInfoResponse(val action: String? = null, val additionalConfigurations: Map<String, String>? = null, val additionalConnectionStringProperties: Map<String, String>? = null, val configurationStore: ConfigurationStoreResponse? = null, val customizedKeys: Map<String, String>? = null, val daprProperties: DaprPropertiesResponse? = null, val deleteOrUpdateBehavior: String? = null)

The configuration information, used to generate configurations or save to applications

Link copied to clipboard
data class ConfigurationStoreResponse(val appConfigurationId: String? = null)

An option to store configuration into different place

Link copied to clipboard
data class ConfluentBootstrapServerResponse(val endpoint: String? = null, val type: String)

The service properties when target service type is ConfluentBootstrapServer

Link copied to clipboard
data class ConfluentSchemaRegistryResponse(val endpoint: String? = null, val type: String)

The service properties when target service type is ConfluentSchemaRegistry

Link copied to clipboard
data class CreateOrUpdateDryrunParametersResponse(val actionName: String, val authInfo: Any? = null, val clientType: String? = null, val configurationInfo: ConfigurationInfoResponse? = null, val provisioningState: String, val publicNetworkSolution: PublicNetworkSolutionResponse? = null, val scope: String? = null, val secretStore: SecretStoreResponse? = null, val targetService: Any? = null, val vNetSolution: VNetSolutionResponse? = null)

The dryrun parameters for creation or update a linker

Link copied to clipboard
data class DaprMetadataResponse(val description: String? = null, val name: String? = null, val required: String? = null, val secretRef: String? = null, val value: String? = null)

The dapr component metadata.

Link copied to clipboard
data class DaprPropertiesResponse(val bindingComponentDirection: String, val componentType: String? = null, val metadata: List<DaprMetadataResponse>? = null, val runtimeVersion: String, val scopes: List<String>? = null, val secretStoreComponent: String? = null, val version: String? = null)

Indicates some additional properties for dapr client type

Link copied to clipboard
data class DryrunOperationPreviewResponse(val action: String? = null, val description: String? = null, val name: String? = null, val operationType: String? = null, val scope: String? = null)

The preview of the operations for creation

Link copied to clipboard
data class EasyAuthMicrosoftEntraIDAuthInfoResponse(val authMode: String? = null, val authType: String, val clientId: String? = null, val deleteOrUpdateBehavior: String? = null, val secret: String? = null)

The authentication info when authType is EasyAuth Microsoft Entra ID

Link copied to clipboard
data class FirewallRulesResponse(val azureServices: String? = null, val callerClientIP: String? = null, val ipRanges: List<String>? = null)

Target service's firewall rules. to allow connections from source service.

Link copied to clipboard
data class GetConnectorDryrunResult(val azureApiVersion: String, val id: String, val name: String, val operationPreviews: List<DryrunOperationPreviewResponse>, val parameters: CreateOrUpdateDryrunParametersResponse? = null, val prerequisiteResults: List<Either<BasicErrorDryrunPrerequisiteResultResponse, PermissionsMissingDryrunPrerequisiteResultResponse>>, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

a dryrun job resource

Link copied to clipboard
data class GetConnectorResult(val authInfo: Any? = null, val azureApiVersion: String, val clientType: String? = null, val configurationInfo: ConfigurationInfoResponse? = null, val id: String, val name: String, val provisioningState: String, val publicNetworkSolution: PublicNetworkSolutionResponse? = null, val scope: String? = null, val secretStore: SecretStoreResponse? = null, val systemData: SystemDataResponse, val targetService: Any? = null, val type: String, val vNetSolution: VNetSolutionResponse? = null)

Linker of source and target resource

Link copied to clipboard
data class GetLinkerDryrunResult(val azureApiVersion: String, val id: String, val name: String, val operationPreviews: List<DryrunOperationPreviewResponse>, val parameters: CreateOrUpdateDryrunParametersResponse? = null, val prerequisiteResults: List<Either<BasicErrorDryrunPrerequisiteResultResponse, PermissionsMissingDryrunPrerequisiteResultResponse>>, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

a dryrun job resource

Link copied to clipboard
data class GetLinkerResult(val authInfo: Any? = null, val azureApiVersion: String, val clientType: String? = null, val configurationInfo: ConfigurationInfoResponse? = null, val id: String, val name: String, val provisioningState: String, val publicNetworkSolution: PublicNetworkSolutionResponse? = null, val scope: String? = null, val secretStore: SecretStoreResponse? = null, val systemData: SystemDataResponse, val targetService: Any? = null, val type: String, val vNetSolution: VNetSolutionResponse? = null)

Linker of source and target resource

data class KeyVaultSecretReferenceSecretInfoResponse(val name: String? = null, val secretType: String, val version: String? = null)

The secret info when type is keyVaultSecretReference. It's for scenario that user provides a secret stored in user's keyvault and source is Azure Kubernetes. The key Vault's resource id is linked to secretStore.keyVaultId.

Link copied to clipboard
data class KeyVaultSecretUriSecretInfoResponse(val secretType: String, val value: String? = null)

The secret info when type is keyVaultSecretUri. It's for scenario that user provides a secret stored in user's keyvault and source is Web App, Spring Cloud or Container App.

Link copied to clipboard
data class ListLinkerConfigurationsResult(val configurations: List<SourceConfigurationResponse>? = null)

Configurations for source resource, include appSettings, connectionString and serviceBindings

data class PermissionsMissingDryrunPrerequisiteResultResponse(val permissions: List<String>? = null, val recommendedRole: String? = null, val scope: String? = null, val type: String)

The represent of missing permissions

Link copied to clipboard
data class PublicNetworkSolutionResponse(val action: String? = null, val deleteOrUpdateBehavior: String? = null, val firewallRules: FirewallRulesResponse? = null)

Indicates public network solution, include firewall rules

Link copied to clipboard
data class SecretAuthInfoResponse(val authMode: String? = null, val authType: String, val name: String? = null, val secretInfo: Any? = null)

The authentication info when authType is secret

Link copied to clipboard
data class SecretStoreResponse(val keyVaultId: String? = null, val keyVaultSecretName: String? = null)

An option to store secret value in secure place

Link copied to clipboard
data class SelfHostedServerResponse(val endpoint: String? = null, val type: String)

The service properties when target service type is SelfHostedServer

data class ServicePrincipalCertificateAuthInfoResponse(val authMode: String? = null, val authType: String, val certificate: String, val clientId: String, val deleteOrUpdateBehavior: String? = null, val principalId: String, val roles: List<String>? = null)

The authentication info when authType is servicePrincipal certificate

Link copied to clipboard
data class ServicePrincipalSecretAuthInfoResponse(val authMode: String? = null, val authType: String, val clientId: String, val deleteOrUpdateBehavior: String? = null, val principalId: String, val roles: List<String>? = null, val secret: String, val userName: String? = null)

The authentication info when authType is servicePrincipal secret

Link copied to clipboard
data class SourceConfigurationResponse(val configType: String, val description: String? = null, val keyVaultReferenceIdentity: String? = null, val name: String? = null, val value: String? = null)

A configuration item for source resource

Link copied to clipboard
data class SystemAssignedIdentityAuthInfoResponse(val authMode: String? = null, val authType: String, val deleteOrUpdateBehavior: String? = null, val roles: List<String>? = null, val userName: String? = null)

The authentication info when authType is systemAssignedIdentity

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class UserAccountAuthInfoResponse(val authMode: String? = null, val authType: String, val deleteOrUpdateBehavior: String? = null, val principalId: String? = null, val roles: List<String>? = null, val userName: String? = null)

The authentication info when authType is user account

Link copied to clipboard
data class UserAssignedIdentityAuthInfoResponse(val authMode: String? = null, val authType: String, val clientId: String? = null, val deleteOrUpdateBehavior: String? = null, val roles: List<String>? = null, val subscriptionId: String? = null, val userName: String? = null)

The authentication info when authType is userAssignedIdentity

Link copied to clipboard
data class ValueSecretInfoResponse(val secretType: String, val value: String? = null)

The secret info when type is rawValue. It's for scenarios that user input the secret.

Link copied to clipboard
data class VNetSolutionResponse(val deleteOrUpdateBehavior: String? = null, val type: String? = null)

The VNet solution for linker