servicelinker.azure.com/v20240401
APIVersion
| Value | Description |
|---|---|
| “2024-04-01” |
Linker
Generator information:
- Generated from: /servicelinker/resource-manager/Microsoft.ServiceLinker/ServiceLinker/stable/2024-04-01/servicelinker.json
- ARM URI: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
Used by: LinkerList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Linker_Spec Optional |
|
| status | Linker_STATUS Optional |
Linker_Spec
| Property | Description | Type |
|---|---|---|
| authInfo | The authentication type. | AuthInfoBase Optional |
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| clientType | The application client type | ClientType Optional |
| configurationInfo | The connection information consumed by applications, including secrets, connection strings. | ConfigurationInfo Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | LinkerOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. This resource is an extension resource, which means that any other Azure resource can be its owner. | genruntime.ArbitraryOwnerReference Required |
| publicNetworkSolution | The network solution. | PublicNetworkSolution Optional |
| scope | connection scope in source service. | string Optional |
| secretStore | An option to store secret value in secure place | SecretStore Optional |
| targetService | The target service properties | TargetServiceBase Optional |
| vNetSolution | The VNet solution. | VNetSolution Optional |
Linker_STATUS
| Property | Description | Type |
|---|---|---|
| authInfo | The authentication type. | AuthInfoBase_STATUS Optional |
| clientType | The application client type | ClientType_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| configurationInfo | The connection information consumed by applications, including secrets, connection strings. | ConfigurationInfo_STATUS Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| name | The name of the resource | string Optional |
| provisioningState | The provisioning state. | string Optional |
| publicNetworkSolution | The network solution. | PublicNetworkSolution_STATUS Optional |
| scope | connection scope in source service. | string Optional |
| secretStore | An option to store secret value in secure place | SecretStore_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| targetService | The target service properties | TargetServiceBase_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| vNetSolution | The VNet solution. | VNetSolution_STATUS Optional |
LinkerList
Generator information:
- Generated from: /servicelinker/resource-manager/Microsoft.ServiceLinker/ServiceLinker/stable/2024-04-01/servicelinker.json
- ARM URI: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Linker[] Optional |
Linker_Spec
Used by: Linker.
| Property | Description | Type |
|---|---|---|
| authInfo | The authentication type. | AuthInfoBase Optional |
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| clientType | The application client type | ClientType Optional |
| configurationInfo | The connection information consumed by applications, including secrets, connection strings. | ConfigurationInfo Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | LinkerOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. This resource is an extension resource, which means that any other Azure resource can be its owner. | genruntime.ArbitraryOwnerReference Required |
| publicNetworkSolution | The network solution. | PublicNetworkSolution Optional |
| scope | connection scope in source service. | string Optional |
| secretStore | An option to store secret value in secure place | SecretStore Optional |
| targetService | The target service properties | TargetServiceBase Optional |
| vNetSolution | The VNet solution. | VNetSolution Optional |
Linker_STATUS
Used by: Linker.
| Property | Description | Type |
|---|---|---|
| authInfo | The authentication type. | AuthInfoBase_STATUS Optional |
| clientType | The application client type | ClientType_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| configurationInfo | The connection information consumed by applications, including secrets, connection strings. | ConfigurationInfo_STATUS Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| name | The name of the resource | string Optional |
| provisioningState | The provisioning state. | string Optional |
| publicNetworkSolution | The network solution. | PublicNetworkSolution_STATUS Optional |
| scope | connection scope in source service. | string Optional |
| secretStore | An option to store secret value in secure place | SecretStore_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| targetService | The target service properties | TargetServiceBase_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| vNetSolution | The VNet solution. | VNetSolution_STATUS Optional |
AuthInfoBase
Used by: Linker_Spec.
| Property | Description | Type |
|---|---|---|
| accessKey | Mutually exclusive with all other properties | AccessKeyInfoBase Optional |
| easyAuthMicrosoftEntraID | Mutually exclusive with all other properties | EasyAuthMicrosoftEntraIDAuthInfo Optional |
| secret | Mutually exclusive with all other properties | SecretAuthInfo Optional |
| servicePrincipalCertificate | Mutually exclusive with all other properties | ServicePrincipalCertificateAuthInfo Optional |
| servicePrincipalSecret | Mutually exclusive with all other properties | ServicePrincipalSecretAuthInfo Optional |
| systemAssignedIdentity | Mutually exclusive with all other properties | SystemAssignedIdentityAuthInfo Optional |
| userAccount | Mutually exclusive with all other properties | UserAccountAuthInfo Optional |
| userAssignedIdentity | Mutually exclusive with all other properties | UserAssignedIdentityAuthInfo Optional |
AuthInfoBase_STATUS
Used by: Linker_STATUS.
| Property | Description | Type |
|---|---|---|
| accessKey | Mutually exclusive with all other properties | AccessKeyInfoBase_STATUS Optional |
| easyAuthMicrosoftEntraID | Mutually exclusive with all other properties | EasyAuthMicrosoftEntraIDAuthInfo_STATUS Optional |
| secret | Mutually exclusive with all other properties | SecretAuthInfo_STATUS Optional |
| servicePrincipalCertificate | Mutually exclusive with all other properties | ServicePrincipalCertificateAuthInfo_STATUS Optional |
| servicePrincipalSecret | Mutually exclusive with all other properties | ServicePrincipalSecretAuthInfo_STATUS Optional |
| systemAssignedIdentity | Mutually exclusive with all other properties | SystemAssignedIdentityAuthInfo_STATUS Optional |
| userAccount | Mutually exclusive with all other properties | UserAccountAuthInfo_STATUS Optional |
| userAssignedIdentity | Mutually exclusive with all other properties | UserAssignedIdentityAuthInfo_STATUS Optional |
ClientType
The application client type
Used by: Linker_Spec.
| Value | Description |
|---|---|
| “dapr” | |
| “django” | |
| “dotnet” | |
| “go” | |
| “java” | |
| “jms-springBoot” | |
| “kafka-springBoot” | |
| “nodejs” | |
| “none” | |
| “php” | |
| “python” | |
| “ruby” | |
| “springBoot” |
ClientType_STATUS
The application client type
Used by: Linker_STATUS.
| Value | Description |
|---|---|
| “dapr” | |
| “django” | |
| “dotnet” | |
| “go” | |
| “java” | |
| “jms-springBoot” | |
| “kafka-springBoot” | |
| “nodejs” | |
| “none” | |
| “php” | |
| “python” | |
| “ruby” | |
| “springBoot” |
ConfigurationInfo
The configuration information, used to generate configurations or save to applications
Used by: Linker_Spec.
| Property | Description | Type |
|---|---|---|
| action | Optional, indicate whether to apply configurations on source application. If enable, generate configurations and applied to the source application. Default is enable. If optOut, no configuration change will be made on source. | ActionType Optional |
| additionalConfigurations | 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 | map[string]string Optional |
| additionalConnectionStringProperties | A dictionary of additional properties to be added in the end of connection string. | map[string]string Optional |
| configurationStore | An option to store configuration into different place | ConfigurationStore Optional |
| customizedKeys | Optional. A dictionary of default key name and customized key name mapping. If not specified, default key name will be used for generate configurations | map[string]string Optional |
| daprProperties | Indicates some additional properties for dapr client type | DaprProperties Optional |
| deleteOrUpdateBehavior | Indicates whether to clean up previous operation when Linker is updating or deleting | DeleteOrUpdateBehavior Optional |
ConfigurationInfo_STATUS
The configuration information, used to generate configurations or save to applications
Used by: Linker_STATUS.
| Property | Description | Type |
|---|---|---|
| action | Optional, indicate whether to apply configurations on source application. If enable, generate configurations and applied to the source application. Default is enable. If optOut, no configuration change will be made on source. | ActionType_STATUS Optional |
| additionalConfigurations | 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 | map[string]string Optional |
| additionalConnectionStringProperties | A dictionary of additional properties to be added in the end of connection string. | map[string]string Optional |
| configurationStore | An option to store configuration into different place | ConfigurationStore_STATUS Optional |
| customizedKeys | Optional. A dictionary of default key name and customized key name mapping. If not specified, default key name will be used for generate configurations | map[string]string Optional |
| daprProperties | Indicates some additional properties for dapr client type | DaprProperties_STATUS Optional |
| deleteOrUpdateBehavior | Indicates whether to clean up previous operation when Linker is updating or deleting | DeleteOrUpdateBehavior_STATUS Optional |
LinkerOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Linker_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
PublicNetworkSolution
Indicates public network solution, include firewall rules
Used by: Linker_Spec.
| Property | Description | Type |
|---|---|---|
| action | Optional. Indicates public network solution. If enable, enable public network access of target service with best try. Default is enable. If optOut, opt out public network access configuration. | ActionType Optional |
| deleteOrUpdateBehavior | Indicates whether to clean up previous operation(such as firewall rules) when Linker is updating or deleting | DeleteOrUpdateBehavior Optional |
| firewallRules | Describe firewall rules of target service to make sure source application could connect to the target. | FirewallRules Optional |
PublicNetworkSolution_STATUS
Indicates public network solution, include firewall rules
Used by: Linker_STATUS.
| Property | Description | Type |
|---|---|---|
| action | Optional. Indicates public network solution. If enable, enable public network access of target service with best try. Default is enable. If optOut, opt out public network access configuration. | ActionType_STATUS Optional |
| deleteOrUpdateBehavior | Indicates whether to clean up previous operation(such as firewall rules) when Linker is updating or deleting | DeleteOrUpdateBehavior_STATUS Optional |
| firewallRules | Describe firewall rules of target service to make sure source application could connect to the target. | FirewallRules_STATUS Optional |
SecretStore
An option to store secret value in secure place
Used by: Linker_Spec.
| Property | Description | Type |
|---|---|---|
| keyVaultReference | The key vault id to store secret | genruntime.ResourceReference Optional |
| keyVaultSecretName | The key vault secret name to store secret, only valid when storing one secret | string Optional |
SecretStore_STATUS
An option to store secret value in secure place
Used by: Linker_STATUS.
| Property | Description | Type |
|---|---|---|
| keyVaultId | The key vault id to store secret | string Optional |
| keyVaultSecretName | The key vault secret name to store secret, only valid when storing one secret | string Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: Linker_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
| lastModifiedAt | The timestamp of resource last modification (UTC) | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
TargetServiceBase
Used by: Linker_Spec.
| Property | Description | Type |
|---|---|---|
| azureResource | Mutually exclusive with all other properties | AzureResource Optional |
| confluentBootstrapServer | Mutually exclusive with all other properties | ConfluentBootstrapServer Optional |
| confluentSchemaRegistry | Mutually exclusive with all other properties | ConfluentSchemaRegistry Optional |
| selfHostedServer | Mutually exclusive with all other properties | SelfHostedServer Optional |
TargetServiceBase_STATUS
Used by: Linker_STATUS.
| Property | Description | Type |
|---|---|---|
| azureResource | Mutually exclusive with all other properties | AzureResource_STATUS Optional |
| confluentBootstrapServer | Mutually exclusive with all other properties | ConfluentBootstrapServer_STATUS Optional |
| confluentSchemaRegistry | Mutually exclusive with all other properties | ConfluentSchemaRegistry_STATUS Optional |
| selfHostedServer | Mutually exclusive with all other properties | SelfHostedServer_STATUS Optional |
VNetSolution
The VNet solution for linker
Used by: Linker_Spec.
| Property | Description | Type |
|---|---|---|
| deleteOrUpdateBehavior | Indicates whether to clean up previous operation when Linker is updating or deleting | DeleteOrUpdateBehavior Optional |
| type | Type of VNet solution. | VNetSolution_Type Optional |
VNetSolution_STATUS
The VNet solution for linker
Used by: Linker_STATUS.
| Property | Description | Type |
|---|---|---|
| deleteOrUpdateBehavior | Indicates whether to clean up previous operation when Linker is updating or deleting | DeleteOrUpdateBehavior_STATUS Optional |
| type | Type of VNet solution. | VNetSolution_Type_STATUS Optional |
AccessKeyInfoBase
Used by: AuthInfoBase.
| Property | Description | Type |
|---|---|---|
| authMode | Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. | AuthMode Optional |
| authType | The authentication type. | AccessKeyInfoBase_AuthType Required |
| permissions | Permissions of the accessKey. Read and Write are for Azure Cosmos DB and Azure App Configuration, Listen, Send and Manage are for Azure Event Hub and Azure Service Bus. |
AccessKeyInfoBase_Permissions[] Optional |
AccessKeyInfoBase_STATUS
Used by: AuthInfoBase_STATUS.
| Property | Description | Type |
|---|---|---|
| authMode | Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. | AuthMode_STATUS Optional |
| authType | The authentication type. | AccessKeyInfoBase_AuthType_STATUS Optional |
| permissions | Permissions of the accessKey. Read and Write are for Azure Cosmos DB and Azure App Configuration, Listen, Send and Manage are for Azure Event Hub and Azure Service Bus. |
AccessKeyInfoBase_Permissions_STATUS[] Optional |
ActionType
Indicates how to apply the connector operations, such as opt out network configuration, opt in configuration.
Used by: ConfigurationInfo, and PublicNetworkSolution.
| Value | Description |
|---|---|
| “enable” | |
| “optOut” |
ActionType_STATUS
Indicates how to apply the connector operations, such as opt out network configuration, opt in configuration.
Used by: ConfigurationInfo_STATUS, and PublicNetworkSolution_STATUS.
| Value | Description |
|---|---|
| “enable” | |
| “optOut” |
AzureResource
Used by: TargetServiceBase.
| Property | Description | Type |
|---|---|---|
| reference | The Id of azure resource. | genruntime.ResourceReference Optional |
| resourceProperties | The azure resource connection related properties. | AzureResourcePropertiesBase Optional |
| type | The target service type. | AzureResource_Type Required |
AzureResource_STATUS
Used by: TargetServiceBase_STATUS.
| Property | Description | Type |
|---|---|---|
| id | The Id of azure resource. | string Optional |
| resourceProperties | The azure resource connection related properties. | AzureResourcePropertiesBase_STATUS Optional |
| type | The target service type. | AzureResource_Type_STATUS Optional |
ConfigurationStore
An option to store configuration into different place
Used by: ConfigurationInfo.
| Property | Description | Type |
|---|---|---|
| appConfigurationReference | The app configuration id to store configuration | genruntime.ResourceReference Optional |
ConfigurationStore_STATUS
An option to store configuration into different place
Used by: ConfigurationInfo_STATUS.
| Property | Description | Type |
|---|---|---|
| appConfigurationId | The app configuration id to store configuration | string Optional |
ConfluentBootstrapServer
Used by: TargetServiceBase.
| Property | Description | Type |
|---|---|---|
| endpoint | The endpoint of service. | string Optional |
| type | The target service type. | ConfluentBootstrapServer_Type Required |
ConfluentBootstrapServer_STATUS
Used by: TargetServiceBase_STATUS.
| Property | Description | Type |
|---|---|---|
| endpoint | The endpoint of service. | string Optional |
| type | The target service type. | ConfluentBootstrapServer_Type_STATUS Optional |
ConfluentSchemaRegistry
Used by: TargetServiceBase.
| Property | Description | Type |
|---|---|---|
| endpoint | The endpoint of service. | string Optional |
| type | The target service type. | ConfluentSchemaRegistry_Type Required |
ConfluentSchemaRegistry_STATUS
Used by: TargetServiceBase_STATUS.
| Property | Description | Type |
|---|---|---|
| endpoint | The endpoint of service. | string Optional |
| type | The target service type. | ConfluentSchemaRegistry_Type_STATUS Optional |
DaprProperties
Indicates some additional properties for dapr client type
Used by: ConfigurationInfo.
| Property | Description | Type |
|---|---|---|
| componentType | The dapr component type | string Optional |
| metadata | Additional dapr metadata | DaprMetadata[] Optional |
| scopes | The dapr component scopes | string[] Optional |
| secretStoreComponent | The name of a secret store dapr to retrieve secret | string Optional |
| version | The dapr component version | string Optional |
DaprProperties_STATUS
Indicates some additional properties for dapr client type
Used by: ConfigurationInfo_STATUS.
| Property | Description | Type |
|---|---|---|
| bindingComponentDirection | The direction supported by the dapr binding component | DaprProperties_BindingComponentDirection_STATUS Optional |
| componentType | The dapr component type | string Optional |
| metadata | Additional dapr metadata | DaprMetadata_STATUS[] Optional |
| runtimeVersion | The runtime version supported by the properties | string Optional |
| scopes | The dapr component scopes | string[] Optional |
| secretStoreComponent | The name of a secret store dapr to retrieve secret | string Optional |
| version | The dapr component version | string Optional |
DeleteOrUpdateBehavior
The cleanup behavior to indicate whether clean up operation when resource is deleted or updated
Used by: ConfigurationInfo, EasyAuthMicrosoftEntraIDAuthInfo, PublicNetworkSolution, ServicePrincipalCertificateAuthInfo, ServicePrincipalSecretAuthInfo, SystemAssignedIdentityAuthInfo, UserAccountAuthInfo, UserAssignedIdentityAuthInfo, and VNetSolution.
| Value | Description |
|---|---|
| “Default” | |
| “ForcedCleanup” |
DeleteOrUpdateBehavior_STATUS
The cleanup behavior to indicate whether clean up operation when resource is deleted or updated
Used by: ConfigurationInfo_STATUS, EasyAuthMicrosoftEntraIDAuthInfo_STATUS, PublicNetworkSolution_STATUS, ServicePrincipalCertificateAuthInfo_STATUS, ServicePrincipalSecretAuthInfo_STATUS, SystemAssignedIdentityAuthInfo_STATUS, UserAccountAuthInfo_STATUS, UserAssignedIdentityAuthInfo_STATUS, and VNetSolution_STATUS.
| Value | Description |
|---|---|
| “Default” | |
| “ForcedCleanup” |
EasyAuthMicrosoftEntraIDAuthInfo
Used by: AuthInfoBase.
| Property | Description | Type |
|---|---|---|
| authMode | Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. | AuthMode Optional |
| authType | The authentication type. | EasyAuthMicrosoftEntraIDAuthInfo_AuthType Required |
| clientId | Application clientId for EasyAuth Microsoft Entra ID. | string Optional |
| clientIdFromConfig | Application clientId for EasyAuth Microsoft Entra ID. | genruntime.ConfigMapReference Optional |
| deleteOrUpdateBehavior | Indicates whether to clean up previous operation when Linker is updating or deleting | DeleteOrUpdateBehavior Optional |
| secret | Application Secret for EasyAuth Microsoft Entra ID. | genruntime.SecretReference Optional |
EasyAuthMicrosoftEntraIDAuthInfo_STATUS
Used by: AuthInfoBase_STATUS.
| Property | Description | Type |
|---|---|---|
| authMode | Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. | AuthMode_STATUS Optional |
| authType | The authentication type. | EasyAuthMicrosoftEntraIDAuthInfo_AuthType_STATUS Optional |
| clientId | Application clientId for EasyAuth Microsoft Entra ID. | string Optional |
| deleteOrUpdateBehavior | Indicates whether to clean up previous operation when Linker is updating or deleting | DeleteOrUpdateBehavior_STATUS Optional |
FirewallRules
Target service’s firewall rules. to allow connections from source service.
Used by: PublicNetworkSolution.
| Property | Description | Type |
|---|---|---|
| azureServices | Allow Azure services to access the target service if true. | AllowType Optional |
| callerClientIP | Allow caller client IP to access the target service if true. the property is used when connecting local application to target service. | AllowType Optional |
| ipRanges | 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. | string[] Optional |
FirewallRules_STATUS
Target service’s firewall rules. to allow connections from source service.
Used by: PublicNetworkSolution_STATUS.
| Property | Description | Type |
|---|---|---|
| azureServices | Allow Azure services to access the target service if true. | AllowType_STATUS Optional |
| callerClientIP | Allow caller client IP to access the target service if true. the property is used when connecting local application to target service. | AllowType_STATUS Optional |
| ipRanges | 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. | string[] Optional |
SecretAuthInfo
Used by: AuthInfoBase.
| Property | Description | Type |
|---|---|---|
| authMode | Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. | AuthMode Optional |
| authType | The authentication type. | SecretAuthInfo_AuthType Required |
| name | Username or account name for secret auth. | string Optional |
| secretInfo | Password or key vault secret for secret auth. | SecretInfoBase Optional |
SecretAuthInfo_STATUS
Used by: AuthInfoBase_STATUS.
| Property | Description | Type |
|---|---|---|
| authMode | Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. | AuthMode_STATUS Optional |
| authType | The authentication type. | SecretAuthInfo_AuthType_STATUS Optional |
| name | Username or account name for secret auth. | string Optional |
| secretInfo | Password or key vault secret for secret auth. | SecretInfoBase_STATUS Optional |
SelfHostedServer
Used by: TargetServiceBase.
| Property | Description | Type |
|---|---|---|
| endpoint | The endpoint of service. | string Optional |
| type | The target service type. | SelfHostedServer_Type Required |
SelfHostedServer_STATUS
Used by: TargetServiceBase_STATUS.
| Property | Description | Type |
|---|---|---|
| endpoint | The endpoint of service. | string Optional |
| type | The target service type. | SelfHostedServer_Type_STATUS Optional |
ServicePrincipalCertificateAuthInfo
Used by: AuthInfoBase.
| Property | Description | Type |
|---|---|---|
| authMode | Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. | AuthMode Optional |
| authType | The authentication type. | ServicePrincipalCertificateAuthInfo_AuthType Required |
| certificate | ServicePrincipal certificate for servicePrincipal auth. | genruntime.SecretReference Required |
| clientId | Application clientId for servicePrincipal auth. | string Optional |
| clientIdFromConfig | Application clientId for servicePrincipal auth. | genruntime.ConfigMapReference Optional |
| deleteOrUpdateBehavior | Indicates whether to clean up previous operation when Linker is updating or deleting | DeleteOrUpdateBehavior Optional |
| principalId | Principal Id for servicePrincipal auth. | string Optional |
| principalIdFromConfig | Principal Id for servicePrincipal auth. | genruntime.ConfigMapReference Optional |
| roles | Optional, this value specifies the Azure roles to be assigned. Automatically | string[] Optional |
ServicePrincipalCertificateAuthInfo_STATUS
Used by: AuthInfoBase_STATUS.
| Property | Description | Type |
|---|---|---|
| authMode | Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. | AuthMode_STATUS Optional |
| authType | The authentication type. | ServicePrincipalCertificateAuthInfo_AuthType_STATUS Optional |
| clientId | Application clientId for servicePrincipal auth. | string Optional |
| deleteOrUpdateBehavior | Indicates whether to clean up previous operation when Linker is updating or deleting | DeleteOrUpdateBehavior_STATUS Optional |
| principalId | Principal Id for servicePrincipal auth. | string Optional |
| roles | Optional, this value specifies the Azure roles to be assigned. Automatically | string[] Optional |
ServicePrincipalSecretAuthInfo
Used by: AuthInfoBase.
| Property | Description | Type |
|---|---|---|
| authMode | Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. | AuthMode Optional |
| authType | The authentication type. | ServicePrincipalSecretAuthInfo_AuthType Required |
| clientId | ServicePrincipal application clientId for servicePrincipal auth. | string Optional |
| clientIdFromConfig | ServicePrincipal application clientId for servicePrincipal auth. | genruntime.ConfigMapReference Optional |
| deleteOrUpdateBehavior | Indicates whether to clean up previous operation when Linker is updating or deleting | DeleteOrUpdateBehavior Optional |
| principalId | Principal Id for servicePrincipal auth. | string Optional |
| principalIdFromConfig | Principal Id for servicePrincipal auth. | genruntime.ConfigMapReference Optional |
| roles | Optional, this value specifies the Azure roles to be assigned. Automatically | string[] Optional |
| secret | Secret for servicePrincipal auth. | genruntime.SecretReference Required |
| userName | Username created in the database which is mapped to a user in AAD. | string Optional |
ServicePrincipalSecretAuthInfo_STATUS
Used by: AuthInfoBase_STATUS.
| Property | Description | Type |
|---|---|---|
| authMode | Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. | AuthMode_STATUS Optional |
| authType | The authentication type. | ServicePrincipalSecretAuthInfo_AuthType_STATUS Optional |
| clientId | ServicePrincipal application clientId for servicePrincipal auth. | string Optional |
| deleteOrUpdateBehavior | Indicates whether to clean up previous operation when Linker is updating or deleting | DeleteOrUpdateBehavior_STATUS Optional |
| principalId | Principal Id for servicePrincipal auth. | string Optional |
| roles | Optional, this value specifies the Azure roles to be assigned. Automatically | string[] Optional |
| userName | Username created in the database which is mapped to a user in AAD. | string Optional |
SystemAssignedIdentityAuthInfo
Used by: AuthInfoBase.
| Property | Description | Type |
|---|---|---|
| authMode | Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. | AuthMode Optional |
| authType | The authentication type. | SystemAssignedIdentityAuthInfo_AuthType Required |
| deleteOrUpdateBehavior | Indicates whether to clean up previous operation when Linker is updating or deleting | DeleteOrUpdateBehavior Optional |
| roles | Optional, this value specifies the Azure role to be assigned | string[] Optional |
| userName | Username created in the database which is mapped to a user in AAD. | string Optional |
SystemAssignedIdentityAuthInfo_STATUS
Used by: AuthInfoBase_STATUS.
| Property | Description | Type |
|---|---|---|
| authMode | Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. | AuthMode_STATUS Optional |
| authType | The authentication type. | SystemAssignedIdentityAuthInfo_AuthType_STATUS Optional |
| deleteOrUpdateBehavior | Indicates whether to clean up previous operation when Linker is updating or deleting | DeleteOrUpdateBehavior_STATUS Optional |
| roles | Optional, this value specifies the Azure role to be assigned | string[] Optional |
| userName | Username created in the database which is mapped to a user in AAD. | string Optional |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
UserAccountAuthInfo
Used by: AuthInfoBase.
| Property | Description | Type |
|---|---|---|
| authMode | Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. | AuthMode Optional |
| authType | The authentication type. | UserAccountAuthInfo_AuthType Required |
| deleteOrUpdateBehavior | Indicates whether to clean up previous operation when Linker is updating or deleting | DeleteOrUpdateBehavior Optional |
| principalId | Principal Id for user account. | string Optional |
| roles | Optional, this value specifies the Azure roles to be assigned. Automatically | string[] Optional |
| userName | Username created in the database which is mapped to a user in AAD. | string Optional |
UserAccountAuthInfo_STATUS
Used by: AuthInfoBase_STATUS.
| Property | Description | Type |
|---|---|---|
| authMode | Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. | AuthMode_STATUS Optional |
| authType | The authentication type. | UserAccountAuthInfo_AuthType_STATUS Optional |
| deleteOrUpdateBehavior | Indicates whether to clean up previous operation when Linker is updating or deleting | DeleteOrUpdateBehavior_STATUS Optional |
| principalId | Principal Id for user account. | string Optional |
| roles | Optional, this value specifies the Azure roles to be assigned. Automatically | string[] Optional |
| userName | Username created in the database which is mapped to a user in AAD. | string Optional |
UserAssignedIdentityAuthInfo
Used by: AuthInfoBase.
| Property | Description | Type |
|---|---|---|
| authMode | Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. | AuthMode Optional |
| authType | The authentication type. | UserAssignedIdentityAuthInfo_AuthType Required |
| clientId | Client Id for userAssignedIdentity. | string Optional |
| clientIdFromConfig | Client Id for userAssignedIdentity. | genruntime.ConfigMapReference Optional |
| deleteOrUpdateBehavior | Indicates whether to clean up previous operation when Linker is updating or deleting | DeleteOrUpdateBehavior Optional |
| roles | Optional, this value specifies the Azure role to be assigned | string[] Optional |
| subscriptionId | Subscription id for userAssignedIdentity. | string Optional |
| subscriptionIdFromConfig | Subscription id for userAssignedIdentity. | genruntime.ConfigMapReference Optional |
| userName | Username created in the database which is mapped to a user in AAD. | string Optional |
UserAssignedIdentityAuthInfo_STATUS
Used by: AuthInfoBase_STATUS.
| Property | Description | Type |
|---|---|---|
| authMode | Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. | AuthMode_STATUS Optional |
| authType | The authentication type. | UserAssignedIdentityAuthInfo_AuthType_STATUS Optional |
| clientId | Client Id for userAssignedIdentity. | string Optional |
| deleteOrUpdateBehavior | Indicates whether to clean up previous operation when Linker is updating or deleting | DeleteOrUpdateBehavior_STATUS Optional |
| roles | Optional, this value specifies the Azure role to be assigned | string[] Optional |
| subscriptionId | Subscription id for userAssignedIdentity. | string Optional |
| userName | Username created in the database which is mapped to a user in AAD. | string Optional |
VNetSolution_Type
Used by: VNetSolution.
| Value | Description |
|---|---|
| “privateLink” | |
| “serviceEndpoint” |
VNetSolution_Type_STATUS
Used by: VNetSolution_STATUS.
| Value | Description |
|---|---|
| “privateLink” | |
| “serviceEndpoint” |
AccessKeyInfoBase_AuthType
Used by: AccessKeyInfoBase.
| Value | Description |
|---|---|
| “accessKey” |
AccessKeyInfoBase_AuthType_STATUS
Used by: AccessKeyInfoBase_STATUS.
| Value | Description |
|---|---|
| “accessKey” |
AccessKeyInfoBase_Permissions
Used by: AccessKeyInfoBase.
| Value | Description |
|---|---|
| “Listen” | |
| “Manage” | |
| “Read” | |
| “Send” | |
| “Write” |
AccessKeyInfoBase_Permissions_STATUS
Used by: AccessKeyInfoBase_STATUS.
| Value | Description |
|---|---|
| “Listen” | |
| “Manage” | |
| “Read” | |
| “Send” | |
| “Write” |
AllowType
Whether to allow firewall rules.
Used by: FirewallRules, and FirewallRules.
| Value | Description |
|---|---|
| “false” | |
| “true” |
AllowType_STATUS
Whether to allow firewall rules.
Used by: FirewallRules_STATUS, and FirewallRules_STATUS.
| Value | Description |
|---|---|
| “false” | |
| “true” |
AuthMode
Indicates how to apply the authentication configuration operations.
Used by: AccessKeyInfoBase, EasyAuthMicrosoftEntraIDAuthInfo, SecretAuthInfo, ServicePrincipalCertificateAuthInfo, ServicePrincipalSecretAuthInfo, SystemAssignedIdentityAuthInfo, UserAccountAuthInfo, and UserAssignedIdentityAuthInfo.
| Value | Description |
|---|---|
| “optInAllAuth” | |
| “optOutAllAuth” |
AuthMode_STATUS
Indicates how to apply the authentication configuration operations.
Used by: AccessKeyInfoBase_STATUS, EasyAuthMicrosoftEntraIDAuthInfo_STATUS, SecretAuthInfo_STATUS, ServicePrincipalCertificateAuthInfo_STATUS, ServicePrincipalSecretAuthInfo_STATUS, SystemAssignedIdentityAuthInfo_STATUS, UserAccountAuthInfo_STATUS, and UserAssignedIdentityAuthInfo_STATUS.
| Value | Description |
|---|---|
| “optInAllAuth” | |
| “optOutAllAuth” |
AzureResource_Type
Used by: AzureResource.
| Value | Description |
|---|---|
| “AzureResource” |
AzureResource_Type_STATUS
Used by: AzureResource_STATUS.
| Value | Description |
|---|---|
| “AzureResource” |
AzureResourcePropertiesBase
Used by: AzureResource.
| Property | Description | Type |
|---|---|---|
| keyVault | Mutually exclusive with all other properties | AzureKeyVaultProperties Optional |
AzureResourcePropertiesBase_STATUS
Used by: AzureResource_STATUS.
| Property | Description | Type |
|---|---|---|
| keyVault | Mutually exclusive with all other properties | AzureKeyVaultProperties_STATUS Optional |
ConfluentBootstrapServer_Type
Used by: ConfluentBootstrapServer.
| Value | Description |
|---|---|
| “ConfluentBootstrapServer” |
ConfluentBootstrapServer_Type_STATUS
Used by: ConfluentBootstrapServer_STATUS.
| Value | Description |
|---|---|
| “ConfluentBootstrapServer” |
ConfluentSchemaRegistry_Type
Used by: ConfluentSchemaRegistry.
| Value | Description |
|---|---|
| “ConfluentSchemaRegistry” |
ConfluentSchemaRegistry_Type_STATUS
Used by: ConfluentSchemaRegistry_STATUS.
| Value | Description |
|---|---|
| “ConfluentSchemaRegistry” |
DaprMetadata
The dapr component metadata.
Used by: DaprProperties.
| Property | Description | Type |
|---|---|---|
| description | The description of the metadata, returned from configuration api | string Optional |
| name | Metadata property name. | string Optional |
| required | The value indicating whether the metadata is required or not | DaprMetadata_Required Optional |
| secretRef | The secret name where dapr could get value | string Optional |
| value | Metadata property value. | string Optional |
DaprMetadata_STATUS
The dapr component metadata.
Used by: DaprProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| description | The description of the metadata, returned from configuration api | string Optional |
| name | Metadata property name. | string Optional |
| required | The value indicating whether the metadata is required or not | DaprMetadata_Required_STATUS Optional |
| secretRef | The secret name where dapr could get value | string Optional |
| value | Metadata property value. | string Optional |
DaprProperties_BindingComponentDirection_STATUS
Used by: DaprProperties_STATUS.
| Value | Description |
|---|---|
| “input” | |
| “output” |
EasyAuthMicrosoftEntraIDAuthInfo_AuthType
Used by: EasyAuthMicrosoftEntraIDAuthInfo.
| Value | Description |
|---|---|
| “easyAuthMicrosoftEntraID” |
EasyAuthMicrosoftEntraIDAuthInfo_AuthType_STATUS
Used by: EasyAuthMicrosoftEntraIDAuthInfo_STATUS.
| Value | Description |
|---|---|
| “easyAuthMicrosoftEntraID” |
SecretAuthInfo_AuthType
Used by: SecretAuthInfo.
| Value | Description |
|---|---|
| “secret” |
SecretAuthInfo_AuthType_STATUS
Used by: SecretAuthInfo_STATUS.
| Value | Description |
|---|---|
| “secret” |
SecretInfoBase
Used by: SecretAuthInfo.
| Property | Description | Type |
|---|---|---|
| keyVaultSecretReference | Mutually exclusive with all other properties | KeyVaultSecretReferenceSecretInfo Optional |
| keyVaultSecretUri | Mutually exclusive with all other properties | KeyVaultSecretUriSecretInfo Optional |
| rawValue | Mutually exclusive with all other properties | ValueSecretInfo Optional |
SecretInfoBase_STATUS
Used by: SecretAuthInfo_STATUS.
| Property | Description | Type |
|---|---|---|
| keyVaultSecretReference | Mutually exclusive with all other properties | KeyVaultSecretReferenceSecretInfo_STATUS Optional |
| keyVaultSecretUri | Mutually exclusive with all other properties | KeyVaultSecretUriSecretInfo_STATUS Optional |
| rawValue | Mutually exclusive with all other properties | ValueSecretInfo_STATUS Optional |
SelfHostedServer_Type
Used by: SelfHostedServer.
| Value | Description |
|---|---|
| “SelfHostedServer” |
SelfHostedServer_Type_STATUS
Used by: SelfHostedServer_STATUS.
| Value | Description |
|---|---|
| “SelfHostedServer” |
ServicePrincipalCertificateAuthInfo_AuthType
Used by: ServicePrincipalCertificateAuthInfo.
| Value | Description |
|---|---|
| “servicePrincipalCertificate” |
ServicePrincipalCertificateAuthInfo_AuthType_STATUS
Used by: ServicePrincipalCertificateAuthInfo_STATUS.
| Value | Description |
|---|---|
| “servicePrincipalCertificate” |
ServicePrincipalSecretAuthInfo_AuthType
Used by: ServicePrincipalSecretAuthInfo.
| Value | Description |
|---|---|
| “servicePrincipalSecret” |
ServicePrincipalSecretAuthInfo_AuthType_STATUS
Used by: ServicePrincipalSecretAuthInfo_STATUS.
| Value | Description |
|---|---|
| “servicePrincipalSecret” |
SystemAssignedIdentityAuthInfo_AuthType
Used by: SystemAssignedIdentityAuthInfo.
| Value | Description |
|---|---|
| “systemAssignedIdentity” |
SystemAssignedIdentityAuthInfo_AuthType_STATUS
Used by: SystemAssignedIdentityAuthInfo_STATUS.
| Value | Description |
|---|---|
| “systemAssignedIdentity” |
UserAccountAuthInfo_AuthType
Used by: UserAccountAuthInfo.
| Value | Description |
|---|---|
| “userAccount” |
UserAccountAuthInfo_AuthType_STATUS
Used by: UserAccountAuthInfo_STATUS.
| Value | Description |
|---|---|
| “userAccount” |
UserAssignedIdentityAuthInfo_AuthType
Used by: UserAssignedIdentityAuthInfo.
| Value | Description |
|---|---|
| “userAssignedIdentity” |
UserAssignedIdentityAuthInfo_AuthType_STATUS
Used by: UserAssignedIdentityAuthInfo_STATUS.
| Value | Description |
|---|---|
| “userAssignedIdentity” |
AzureKeyVaultProperties
Used by: AzureResourcePropertiesBase.
| Property | Description | Type |
|---|---|---|
| connectAsKubernetesCsiDriver | True if connect via Kubernetes CSI Driver. | bool Optional |
| type | The azure resource type. | AzureResourceType Required |
AzureKeyVaultProperties_STATUS
Used by: AzureResourcePropertiesBase_STATUS.
| Property | Description | Type |
|---|---|---|
| connectAsKubernetesCsiDriver | True if connect via Kubernetes CSI Driver. | bool Optional |
| type | The azure resource type. | AzureResourceType_STATUS Optional |
DaprMetadata_Required
Used by: DaprMetadata.
| Value | Description |
|---|---|
| “false” | |
| “true” |
DaprMetadata_Required_STATUS
Used by: DaprMetadata_STATUS.
| Value | Description |
|---|---|
| “false” | |
| “true” |
KeyVaultSecretReferenceSecretInfo
Used by: SecretInfoBase.
| Property | Description | Type |
|---|---|---|
| name | Name of the Key Vault secret. | string Optional |
| secretType | The secret type. | KeyVaultSecretReferenceSecretInfo_SecretType Required |
| version | Version of the Key Vault secret. | string Optional |
KeyVaultSecretReferenceSecretInfo_STATUS
Used by: SecretInfoBase_STATUS.
| Property | Description | Type |
|---|---|---|
| name | Name of the Key Vault secret. | string Optional |
| secretType | The secret type. | KeyVaultSecretReferenceSecretInfo_SecretType_STATUS Optional |
| version | Version of the Key Vault secret. | string Optional |
KeyVaultSecretUriSecretInfo
Used by: SecretInfoBase.
| Property | Description | Type |
|---|---|---|
| secretType | The secret type. | KeyVaultSecretUriSecretInfo_SecretType Required |
| value | URI to the keyvault secret | string Optional |
KeyVaultSecretUriSecretInfo_STATUS
Used by: SecretInfoBase_STATUS.
| Property | Description | Type |
|---|---|---|
| secretType | The secret type. | KeyVaultSecretUriSecretInfo_SecretType_STATUS Optional |
| value | URI to the keyvault secret | string Optional |
ValueSecretInfo
Used by: SecretInfoBase.
| Property | Description | Type |
|---|---|---|
| secretType | The secret type. | ValueSecretInfo_SecretType Required |
| value | The actual value of the secret. | genruntime.SecretReference Optional |
ValueSecretInfo_STATUS
Used by: SecretInfoBase_STATUS.
| Property | Description | Type |
|---|---|---|
| secretType | The secret type. | ValueSecretInfo_SecretType_STATUS Optional |
AzureResourceType
The azure resource type.
Used by: AzureKeyVaultProperties.
| Value | Description |
|---|---|
| “KeyVault” |
AzureResourceType_STATUS
The azure resource type.
Used by: AzureKeyVaultProperties_STATUS.
| Value | Description |
|---|---|
| “KeyVault” |
KeyVaultSecretReferenceSecretInfo_SecretType
Used by: KeyVaultSecretReferenceSecretInfo.
| Value | Description |
|---|---|
| “keyVaultSecretReference” |
KeyVaultSecretReferenceSecretInfo_SecretType_STATUS
Used by: KeyVaultSecretReferenceSecretInfo_STATUS.
| Value | Description |
|---|---|
| “keyVaultSecretReference” |
KeyVaultSecretUriSecretInfo_SecretType
Used by: KeyVaultSecretUriSecretInfo.
| Value | Description |
|---|---|
| “keyVaultSecretUri” |
KeyVaultSecretUriSecretInfo_SecretType_STATUS
Used by: KeyVaultSecretUriSecretInfo_STATUS.
| Value | Description |
|---|---|
| “keyVaultSecretUri” |
ValueSecretInfo_SecretType
Used by: ValueSecretInfo.
| Value | Description |
|---|---|
| “rawValue” |
ValueSecretInfo_SecretType_STATUS
Used by: ValueSecretInfo_STATUS.
| Value | Description |
|---|---|
| “rawValue” |