@azure/arm-servicelinker package

Classes

ServiceLinkerManagementClient

Interfaces

AuthInfoBase

The authentication info

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

ConfluentBootstrapServer

The service properties when target service type is ConfluentBootstrapServer

ConfluentSchemaRegistry

The service properties when target service type is ConfluentSchemaRegistry

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.).

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.

LinkerList

The list of Linker.

LinkerListConfigurationsOptionalParams

Optional parameters.

LinkerListNextOptionalParams

Optional parameters.

LinkerListOptionalParams

Optional parameters.

LinkerPatch

A linker to be updated.

LinkerResource

Linker of source and target resource

LinkerUpdateOptionalParams

Optional parameters.

LinkerValidateOptionalParams

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.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

SecretAuthInfo

The authentication info when authType is secret

SecretInfoBase

The secret info

SecretStore

An option to store secret value in secure place

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

SourceConfigurationResult

Configurations for source resource, include appSettings, connectionString and serviceBindings

SystemAssignedIdentityAuthInfo

The authentication info when authType is systemAssignedIdentity

SystemData

Metadata pertaining to creation and last modification of the resource.

TargetServiceBase

The target service properties

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

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

AuthInfoBaseUnion
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

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

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

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

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.

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
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

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

KnownActionType

Known values of ActionType 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.

KnownOrigin

Known values of Origin 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.