@azure/arm-servicelinker package

Classes

ServiceLinkerManagementClient

Interfaces

AccessKeyInfoBase	The access key directly from target resource properties, which target service is Azure Resource, such as Microsoft.Storage
AuthInfoBase	The authentication info
AzureAppConfigProperties	The resource properties when type is Azure App Configuration
AzureKeyVaultProperties	The resource properties when type is Azure Key Vault
AzureResource	The azure resource info when target service type is AzureResource
AzureResourcePropertiesBase	The azure resource properties
BasicErrorDryrunPrerequisiteResult	The represent of basic error
ConfigurationInfo	The configuration information, used to generate configurations or save to applications
ConfigurationName	The configuration names.
ConfigurationNameItem
ConfigurationNameResult	Configuration Name list which will be set based on different target resource, client type, auth type.
ConfigurationNames	Interface representing a ConfigurationNames.
ConfigurationNamesListNextOptionalParams	Optional parameters.
ConfigurationNamesListOptionalParams	Optional parameters.
ConfigurationResult	Configurations for source resource, include appSettings, connectionString and serviceBindings
ConfigurationStore	An option to store configuration into different place
ConfluentBootstrapServer	The service properties when target service type is ConfluentBootstrapServer
ConfluentSchemaRegistry	The service properties when target service type is ConfluentSchemaRegistry
Connector	Interface representing a Connector.
ConnectorCreateDryrunOptionalParams	Optional parameters.
ConnectorCreateOrUpdateOptionalParams	Optional parameters.
ConnectorDeleteDryrunOptionalParams	Optional parameters.
ConnectorDeleteOptionalParams	Optional parameters.
ConnectorGenerateConfigurationsOptionalParams	Optional parameters.
ConnectorGetDryrunOptionalParams	Optional parameters.
ConnectorGetOptionalParams	Optional parameters.
ConnectorListDryrunNextOptionalParams	Optional parameters.
ConnectorListDryrunOptionalParams	Optional parameters.
ConnectorListNextOptionalParams	Optional parameters.
ConnectorListOptionalParams	Optional parameters.
ConnectorUpdateDryrunOptionalParams	Optional parameters.
ConnectorUpdateOptionalParams	Optional parameters.
ConnectorValidateOptionalParams	Optional parameters.
CreateOrUpdateDryrunParameters	The dryrun parameters for creation or update a linker
DaprConfigurationList	Dapr configuration list supported by Service Connector
DaprConfigurationResource	Represent one resource of the dapr configuration list
DaprMetadata	The dapr component metadata.
DaprProperties	Indicates some additional properties for dapr client type
DatabaseAadAuthInfo	The extra auth info required by Database AAD authentication.
DryrunList	The list of dryrun.
DryrunOperationPreview	The preview of the operations for creation
DryrunParameters	The parameters of the dryrun
DryrunPatch	a dryrun job to be updated.
DryrunPrerequisiteResult	A result of dryrun
DryrunResource	a dryrun job resource
EasyAuthMicrosoftEntraIDAuthInfo	The authentication info when authType is EasyAuth Microsoft Entra ID
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
FabricPlatform	The service properties when target service type is FabricPlatform
FirewallRules	Target service's firewall rules. to allow connections from source service.
KeyVaultSecretReferenceSecretInfo	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.
KeyVaultSecretUriSecretInfo	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.
Linker	Interface representing a Linker.
LinkerCreateOrUpdateOptionalParams	Optional parameters.
LinkerDeleteOptionalParams	Optional parameters.
LinkerGetOptionalParams	Optional parameters.
LinkerListConfigurationsOptionalParams	Optional parameters.
LinkerListNextOptionalParams	Optional parameters.
LinkerListOptionalParams	Optional parameters.
LinkerPatch	A Linker to be updated.
LinkerProperties	The properties of the Linker.
LinkerResource	Linker of source and target resource
LinkerUpdateOptionalParams	Optional parameters.
LinkerValidateOptionalParams	Optional parameters.
Linkers	Interface representing a Linkers.
LinkersCreateDryrunOptionalParams	Optional parameters.
LinkersDeleteDryrunOptionalParams	Optional parameters.
LinkersGenerateConfigurationsOptionalParams	Optional parameters.
LinkersGetDryrunOptionalParams	Optional parameters.
LinkersListDaprConfigurationsNextOptionalParams	Optional parameters.
LinkersListDaprConfigurationsOptionalParams	Optional parameters.
LinkersListDryrunNextOptionalParams	Optional parameters.
LinkersListDryrunOptionalParams	Optional parameters.
LinkersUpdateDryrunOptionalParams	Optional parameters.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for this particular operation.
OperationListResult	A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
PermissionsMissingDryrunPrerequisiteResult	The represent of missing permissions
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
PublicNetworkSolution	Indicates public network solution, include firewall rules
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceList	The list of Linker.
SecretAuthInfo	The authentication info when authType is secret
SecretInfoBase	The secret info
SecretStore	An option to store secret value in secure place
SelfHostedServer	The service properties when target service type is SelfHostedServer
ServiceLinkerManagementClientOptionalParams	Optional parameters.
ServicePrincipalCertificateAuthInfo	The authentication info when authType is servicePrincipal certificate
ServicePrincipalSecretAuthInfo	The authentication info when authType is servicePrincipal secret
SourceConfiguration	A configuration item for source resource
SystemAssignedIdentityAuthInfo	The authentication info when authType is systemAssignedIdentity
SystemData	Metadata pertaining to creation and last modification of the resource.
TargetServiceBase	The target service properties
UserAccountAuthInfo	The authentication info when authType is user account
UserAssignedIdentityAuthInfo	The authentication info when authType is userAssignedIdentity
VNetSolution	The VNet solution for linker
ValidateOperationResult	The validation operation result for a Linker.
ValidationResultItem	The validation item for a Linker.
ValueSecretInfo	The secret info when type is rawValue. It's for scenarios that user input the secret.

Type Aliases

AccessKeyPermissions	Defines values for AccessKeyPermissions. KnownAccessKeyPermissions can be used interchangeably with AccessKeyPermissions, this enum contains the known values that the service supports. Known values supported by the service Read Write Listen Send Manage
ActionType	Defines values for ActionType. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal enable optOut
AllowType	Defines values for AllowType. KnownAllowType can be used interchangeably with AllowType, this enum contains the known values that the service supports. Known values supported by the service true false
AuthInfoBaseUnion
AuthMode	Defines values for AuthMode. KnownAuthMode can be used interchangeably with AuthMode, this enum contains the known values that the service supports. Known values supported by the service optInAllAuth: Default authentication configuration according to the authentication type. optOutAllAuth: Skip all authentication configuration such as enabling managed identity and granting RBAC roles
AuthType	Defines values for AuthType. KnownAuthType can be used interchangeably with AuthType, this enum contains the known values that the service supports. Known values supported by the service systemAssignedIdentity userAssignedIdentity servicePrincipalSecret servicePrincipalCertificate secret accessKey userAccount easyAuthMicrosoftEntraID
AzureResourcePropertiesBaseUnion
AzureResourceType	Defines values for AzureResourceType. KnownAzureResourceType can be used interchangeably with AzureResourceType, this enum contains the known values that the service supports. Known values supported by the service KeyVault AppConfig
ClientType	Defines values for ClientType. KnownClientType can be used interchangeably with ClientType, this enum contains the known values that the service supports. Known values supported by the service none dotnet java python go php ruby django nodejs springBoot kafka-springBoot jms-springBoot dapr
ConfigurationNamesListNextResponse	Contains response data for the listNext operation.
ConfigurationNamesListResponse	Contains response data for the list operation.
ConnectorCreateDryrunResponse	Contains response data for the createDryrun operation.
ConnectorCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ConnectorGenerateConfigurationsResponse	Contains response data for the generateConfigurations operation.
ConnectorGetDryrunResponse	Contains response data for the getDryrun operation.
ConnectorGetResponse	Contains response data for the get operation.
ConnectorListDryrunNextResponse	Contains response data for the listDryrunNext operation.
ConnectorListDryrunResponse	Contains response data for the listDryrun operation.
ConnectorListNextResponse	Contains response data for the listNext operation.
ConnectorListResponse	Contains response data for the list operation.
ConnectorUpdateDryrunResponse	Contains response data for the updateDryrun operation.
ConnectorUpdateResponse	Contains response data for the update operation.
ConnectorValidateResponse	Contains response data for the validate operation.
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
DaprBindingComponentDirection	Defines values for DaprBindingComponentDirection. KnownDaprBindingComponentDirection can be used interchangeably with DaprBindingComponentDirection, this enum contains the known values that the service supports. Known values supported by the service input output
DaprMetadataRequired	Defines values for DaprMetadataRequired. KnownDaprMetadataRequired can be used interchangeably with DaprMetadataRequired, this enum contains the known values that the service supports. Known values supported by the service true false
DeleteOrUpdateBehavior	Defines values for DeleteOrUpdateBehavior. KnownDeleteOrUpdateBehavior can be used interchangeably with DeleteOrUpdateBehavior, this enum contains the known values that the service supports. Known values supported by the service Default ForcedCleanup
DryrunActionName	Defines values for DryrunActionName. KnownDryrunActionName can be used interchangeably with DryrunActionName, this enum contains the known values that the service supports. Known values supported by the service createOrUpdate
DryrunParametersUnion
DryrunPrerequisiteResultType	Defines values for DryrunPrerequisiteResultType. KnownDryrunPrerequisiteResultType can be used interchangeably with DryrunPrerequisiteResultType, this enum contains the known values that the service supports. Known values supported by the service basicError permissionsMissing
DryrunPrerequisiteResultUnion
DryrunPreviewOperationType	Defines values for DryrunPreviewOperationType. KnownDryrunPreviewOperationType can be used interchangeably with DryrunPreviewOperationType, this enum contains the known values that the service supports. Known values supported by the service configConnection configNetwork configAuth
LinkerConfigurationType	Defines values for LinkerConfigurationType. KnownLinkerConfigurationType can be used interchangeably with LinkerConfigurationType, this enum contains the known values that the service supports. Known values supported by the service Default KeyVaultSecret
LinkerCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
LinkerGetResponse	Contains response data for the get operation.
LinkerListConfigurationsResponse	Contains response data for the listConfigurations operation.
LinkerListNextResponse	Contains response data for the listNext operation.
LinkerListResponse	Contains response data for the list operation.
LinkerUpdateResponse	Contains response data for the update operation.
LinkerValidateResponse	Contains response data for the validate operation.
LinkersCreateDryrunResponse	Contains response data for the createDryrun operation.
LinkersGenerateConfigurationsResponse	Contains response data for the generateConfigurations operation.
LinkersGetDryrunResponse	Contains response data for the getDryrun operation.
LinkersListDaprConfigurationsNextResponse	Contains response data for the listDaprConfigurationsNext operation.
LinkersListDaprConfigurationsResponse	Contains response data for the listDaprConfigurations operation.
LinkersListDryrunNextResponse	Contains response data for the listDryrunNext operation.
LinkersListDryrunResponse	Contains response data for the listDryrun operation.
LinkersUpdateDryrunResponse	Contains response data for the updateDryrun operation.
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
Origin	Defines values for Origin. KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user system user,system
SecretInfoBaseUnion
SecretSourceType	Defines values for SecretSourceType. KnownSecretSourceType can be used interchangeably with SecretSourceType, this enum contains the known values that the service supports. Known values supported by the service rawValue keyVaultSecret
SecretType	Defines values for SecretType. KnownSecretType can be used interchangeably with SecretType, this enum contains the known values that the service supports. Known values supported by the service rawValue keyVaultSecretUri keyVaultSecretReference
TargetServiceBaseUnion
TargetServiceType	Defines values for TargetServiceType. KnownTargetServiceType can be used interchangeably with TargetServiceType, this enum contains the known values that the service supports. Known values supported by the service AzureResource ConfluentBootstrapServer ConfluentSchemaRegistry SelfHostedServer FabricPlatform
VNetSolutionType	Defines values for VNetSolutionType. KnownVNetSolutionType can be used interchangeably with VNetSolutionType, this enum contains the known values that the service supports. Known values supported by the service serviceEndpoint privateLink
ValidationResultStatus	Defines values for ValidationResultStatus. KnownValidationResultStatus can be used interchangeably with ValidationResultStatus, this enum contains the known values that the service supports. Known values supported by the service success failure warning

Enums

KnownAccessKeyPermissions	Known values of AccessKeyPermissions that the service accepts.
KnownActionType	Known values of ActionType that the service accepts.
KnownAllowType	Known values of AllowType that the service accepts.
KnownAuthMode	Known values of AuthMode that the service accepts.
KnownAuthType	Known values of AuthType that the service accepts.
KnownAzureResourceType	Known values of AzureResourceType that the service accepts.
KnownClientType	Known values of ClientType that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownDaprBindingComponentDirection	Known values of DaprBindingComponentDirection that the service accepts.
KnownDaprMetadataRequired	Known values of DaprMetadataRequired that the service accepts.
KnownDeleteOrUpdateBehavior	Known values of DeleteOrUpdateBehavior that the service accepts.
KnownDryrunActionName	Known values of DryrunActionName that the service accepts.
KnownDryrunPrerequisiteResultType	Known values of DryrunPrerequisiteResultType that the service accepts.
KnownDryrunPreviewOperationType	Known values of DryrunPreviewOperationType that the service accepts.
KnownLinkerConfigurationType	Known values of LinkerConfigurationType that the service accepts.
KnownOrigin	Known values of Origin that the service accepts.
KnownSecretSourceType	Known values of SecretSourceType that the service accepts.
KnownSecretType	Known values of SecretType that the service accepts.
KnownTargetServiceType	Known values of TargetServiceType that the service accepts.
KnownVNetSolutionType	Known values of VNetSolutionType that the service accepts.
KnownValidationResultStatus	Known values of ValidationResultStatus that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.