databasewatcher.azure.com/v20241001preview
APIVersion
| Value | Description |
|---|---|
| “2024-10-01-preview” |
SharedPrivateLink
Generator information: - Generated from: /databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2024-10-01-preview/Watcher.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
Used by: SharedPrivateLinkList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | SharedPrivateLink_Spec Optional |
|
| status | SharedPrivateLink_STATUS Optional |
SharedPrivateLink_Spec
| Property | Description | Type |
|---|---|---|
| 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 |
| dnsZone | The DNS zone segment to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances, and must be omitted for SQL logical servers and key vaults. The value is the second segment of the host FQDN name of the resource that the shared private link resource is for. For example: if the host name is ‘adx-cluster-21187695.eastus.kusto.windows.net’, then the value is eastus; if the host name is ‘sql-mi-23961134.767d5869f605.database.windows.net’, then the value is 767d5869f605. |
string Optional |
| groupId | The group id from the provider of resource the shared private link resource is for. | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | SharedPrivateLinkOperatorSpec 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. Owner is expected to be a reference to a databasewatcher.azure.com/Watcher resource | genruntime.KnownResourceReference Required |
| privateLinkResourceReference | The resource ID of the resource the shared private link resource is for. | genruntime.ResourceReference Required |
| requestMessage | The request message for requesting approval of the shared private link resource. | string Required |
SharedPrivateLink_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| dnsZone | The DNS zone segment to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances, and must be omitted for SQL logical servers and key vaults. The value is the second segment of the host FQDN name of the resource that the shared private link resource is for. For example: if the host name is ‘adx-cluster-21187695.eastus.kusto.windows.net’, then the value is eastus; if the host name is ‘sql-mi-23961134.767d5869f605.database.windows.net’, then the value is 767d5869f605. |
string Optional |
| groupId | The group id from the provider of resource the shared private link resource is for. | string Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| name | The name of the resource | string Optional |
| privateLinkResourceId | The resource ID of the resource the shared private link resource is for. | string Optional |
| provisioningState | The provisioning state of the resource. | AzureResourceManagerResourceProvisioningState_STATUS Optional |
| requestMessage | The request message for requesting approval of the shared private link resource. | string Optional |
| status | Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected. | SharedPrivateLinkResourceStatus_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
SharedPrivateLinkList
Generator information: - Generated from: /databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2024-10-01-preview/Watcher.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | SharedPrivateLink[] Optional |
Target
Generator information: - Generated from: /databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2024-10-01-preview/Watcher.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/targets/{targetName}
Used by: TargetList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Target_Spec Optional |
|
| status | Target_STATUS Optional |
Target_Spec
| Property | Description | Type |
|---|---|---|
| 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 |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | TargetOperatorSpec 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. Owner is expected to be a reference to a databasewatcher.azure.com/Watcher resource | genruntime.KnownResourceReference Required |
| properties | The resource-specific properties for this resource. | TargetProperties Optional |
Target_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| name | The name of the resource | string Optional |
| properties | The resource-specific properties for this resource. | TargetProperties_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
TargetList
Generator information: - Generated from: /databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2024-10-01-preview/Watcher.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/targets/{targetName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Target[] Optional |
Watcher
Generator information: - Generated from: /databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2024-10-01-preview/Watcher.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}
Used by: WatcherList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Watcher_Spec Optional |
|
| status | Watcher_STATUS Optional |
Watcher_Spec
| Property | Description | Type |
|---|---|---|
| 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 |
| datastore | The data store for collected monitoring data. | Datastore Optional |
| defaultAlertRuleIdentityResourceReference | The resource ID of a user-assigned managed identity that will be assigned to a new alert rule. | genruntime.ResourceReference Optional |
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity Optional |
| location | The geo-location where the resource lives | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | WatcherOperatorSpec 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. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| tags | Resource tags. | map[string]string Optional |
Watcher_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| datastore | The data store for collected monitoring data. | Datastore_STATUS Optional |
| defaultAlertRuleIdentityResourceId | The resource ID of a user-assigned managed identity that will be assigned to a new alert rule. | string Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| provisioningState | The provisioning state of the resource watcher. | DatabaseWatcherProvisioningState_STATUS Optional |
| status | The monitoring collection status of the watcher. | WatcherStatus_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
WatcherList
Generator information: - Generated from: /databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2024-10-01-preview/Watcher.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Watcher[] Optional |
SharedPrivateLink_Spec
Used by: SharedPrivateLink.
| Property | Description | Type |
|---|---|---|
| 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 |
| dnsZone | The DNS zone segment to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances, and must be omitted for SQL logical servers and key vaults. The value is the second segment of the host FQDN name of the resource that the shared private link resource is for. For example: if the host name is ‘adx-cluster-21187695.eastus.kusto.windows.net’, then the value is eastus; if the host name is ‘sql-mi-23961134.767d5869f605.database.windows.net’, then the value is 767d5869f605. |
string Optional |
| groupId | The group id from the provider of resource the shared private link resource is for. | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | SharedPrivateLinkOperatorSpec 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. Owner is expected to be a reference to a databasewatcher.azure.com/Watcher resource | genruntime.KnownResourceReference Required |
| privateLinkResourceReference | The resource ID of the resource the shared private link resource is for. | genruntime.ResourceReference Required |
| requestMessage | The request message for requesting approval of the shared private link resource. | string Required |
SharedPrivateLink_STATUS
Used by: SharedPrivateLink.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| dnsZone | The DNS zone segment to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances, and must be omitted for SQL logical servers and key vaults. The value is the second segment of the host FQDN name of the resource that the shared private link resource is for. For example: if the host name is ‘adx-cluster-21187695.eastus.kusto.windows.net’, then the value is eastus; if the host name is ‘sql-mi-23961134.767d5869f605.database.windows.net’, then the value is 767d5869f605. |
string Optional |
| groupId | The group id from the provider of resource the shared private link resource is for. | string Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| name | The name of the resource | string Optional |
| privateLinkResourceId | The resource ID of the resource the shared private link resource is for. | string Optional |
| provisioningState | The provisioning state of the resource. | AzureResourceManagerResourceProvisioningState_STATUS Optional |
| requestMessage | The request message for requesting approval of the shared private link resource. | string Optional |
| status | Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected. | SharedPrivateLinkResourceStatus_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
Target_Spec
Used by: Target.
| Property | Description | Type |
|---|---|---|
| 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 |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | TargetOperatorSpec 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. Owner is expected to be a reference to a databasewatcher.azure.com/Watcher resource | genruntime.KnownResourceReference Required |
| properties | The resource-specific properties for this resource. | TargetProperties Optional |
Target_STATUS
Used by: Target.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| name | The name of the resource | string Optional |
| properties | The resource-specific properties for this resource. | TargetProperties_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
Watcher_Spec
Used by: Watcher.
| Property | Description | Type |
|---|---|---|
| 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 |
| datastore | The data store for collected monitoring data. | Datastore Optional |
| defaultAlertRuleIdentityResourceReference | The resource ID of a user-assigned managed identity that will be assigned to a new alert rule. | genruntime.ResourceReference Optional |
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity Optional |
| location | The geo-location where the resource lives | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | WatcherOperatorSpec 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. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| tags | Resource tags. | map[string]string Optional |
Watcher_STATUS
The DatabaseWatcherProviderHub resource.
Used by: Watcher.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| datastore | The data store for collected monitoring data. | Datastore_STATUS Optional |
| defaultAlertRuleIdentityResourceId | The resource ID of a user-assigned managed identity that will be assigned to a new alert rule. | string Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| provisioningState | The provisioning state of the resource watcher. | DatabaseWatcherProvisioningState_STATUS Optional |
| status | The monitoring collection status of the watcher. | WatcherStatus_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
AzureResourceManagerResourceProvisioningState_STATUS
The provisioning state of a resource type.
Used by: SharedPrivateLink_STATUS, SqlDbElasticPoolTargetProperties_STATUS, SqlDbSingleDatabaseTargetProperties_STATUS, SqlMiTargetProperties_STATUS, and SqlVmTargetProperties_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Failed” | |
| “Succeeded” |
DatabaseWatcherProvisioningState_STATUS
The status of the last provisioning operation performed on the resource.
Used by: Watcher_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Failed” | |
| “Succeeded” |
Datastore
The properties of a data store.
Used by: Watcher_Spec.
| Property | Description | Type |
|---|---|---|
| adxClusterResourceReference | The Azure resource ID of an Azure Data Explorer cluster. | genruntime.ResourceReference Optional |
| kustoClusterDisplayName | The Kusto cluster display name. | string Optional |
| kustoClusterUri | The Kusto cluster URI. | string Optional |
| kustoClusterUriFromConfig | The Kusto cluster URI. | genruntime.ConfigMapReference Optional |
| kustoDatabaseName | The name of a Kusto database. | string Required |
| kustoDataIngestionUri | The Kusto data ingestion URI. | string Optional |
| kustoDataIngestionUriFromConfig | The Kusto data ingestion URI. | genruntime.ConfigMapReference Optional |
| kustoManagementUrl | The Kusto management URL. | string Optional |
| kustoManagementUrlFromConfig | The Kusto management URL. | genruntime.ConfigMapReference Optional |
| kustoOfferingType | The type of a Kusto offering. | KustoOfferingType Required |
Datastore_STATUS
The properties of a data store.
Used by: Watcher_STATUS.
| Property | Description | Type |
|---|---|---|
| adxClusterResourceId | The Azure resource ID of an Azure Data Explorer cluster. | string Optional |
| kustoClusterDisplayName | The Kusto cluster display name. | string Optional |
| kustoClusterUri | The Kusto cluster URI. | string Optional |
| kustoDatabaseName | The name of a Kusto database. | string Optional |
| kustoDataIngestionUri | The Kusto data ingestion URI. | string Optional |
| kustoManagementUrl | The Kusto management URL. | string Optional |
| kustoOfferingType | The type of a Kusto offering. | KustoOfferingType_STATUS Optional |
ManagedServiceIdentity
Managed service identity (system assigned and/or user assigned identities)
Used by: Watcher_Spec.
| Property | Description | Type |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | ManagedServiceIdentityType Required |
| userAssignedIdentities | UserAssignedIdentityDetails[] Optional |
ManagedServiceIdentity_STATUS
Managed service identity (system assigned and/or user assigned identities)
Used by: Watcher_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. | string Optional |
| tenantId | The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. | string Optional |
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | ManagedServiceIdentityType_STATUS Optional |
| userAssignedIdentities | map[string]UserAssignedIdentity_STATUS Optional |
SharedPrivateLinkOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: SharedPrivateLink_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 |
SharedPrivateLinkResourceStatus_STATUS
Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
Used by: SharedPrivateLink_STATUS.
| Value | Description |
|---|---|
| “Approved” | |
| “Disconnected” | |
| “Pending” | |
| “Rejected” |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: SharedPrivateLink_STATUS, Target_STATUS, and Watcher_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 |
TargetOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Target_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 |
TargetProperties
Used by: Target_Spec.
| Property | Description | Type |
|---|---|---|
| sqlDb | Mutually exclusive with all other properties | SqlDbSingleDatabaseTargetProperties Optional |
| sqlEp | Mutually exclusive with all other properties | SqlDbElasticPoolTargetProperties Optional |
| sqlMi | Mutually exclusive with all other properties | SqlMiTargetProperties Optional |
| sqlVm | Mutually exclusive with all other properties | SqlVmTargetProperties Optional |
TargetProperties_STATUS
Used by: Target_STATUS.
| Property | Description | Type |
|---|---|---|
| sqlDb | Mutually exclusive with all other properties | SqlDbSingleDatabaseTargetProperties_STATUS Optional |
| sqlEp | Mutually exclusive with all other properties | SqlDbElasticPoolTargetProperties_STATUS Optional |
| sqlMi | Mutually exclusive with all other properties | SqlMiTargetProperties_STATUS Optional |
| sqlVm | Mutually exclusive with all other properties | SqlVmTargetProperties_STATUS Optional |
WatcherOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Watcher_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 |
WatcherStatus_STATUS
The monitoring collection status of a watcher.
Used by: Watcher_STATUS.
| Value | Description |
|---|---|
| “Deleting” | |
| “Running” | |
| “Starting” | |
| “Stopped” | |
| “Stopping” |
KustoOfferingType
The type of Kusto offering.
Used by: Datastore.
| Value | Description |
|---|---|
| “adx” | |
| “fabric” | |
| “free” |
KustoOfferingType_STATUS
The type of Kusto offering.
Used by: Datastore_STATUS.
| Value | Description |
|---|---|
| “adx” | |
| “fabric” | |
| “free” |
ManagedServiceIdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Used by: ManagedServiceIdentity.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned, UserAssigned” | |
| “UserAssigned” |
ManagedServiceIdentityType_STATUS
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Used by: ManagedServiceIdentity_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned, UserAssigned” | |
| “UserAssigned” |
SqlDbElasticPoolTargetProperties
Used by: TargetProperties.
| Property | Description | Type |
|---|---|---|
| anchorDatabaseResourceReference | The Azure resource ID of the anchor database used to connect to an elastic pool. | genruntime.ResourceReference Required |
| connectionServerName | The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be ‘sql-logical-server-22092780.database.windows.net’; for an Azure SQL managed instance in the Azure commercial cloud, the value might be ‘sql-mi-39441134.767d5869f605.database.windows.net’. Port number and instance name must be specified separately. | string Optional |
| connectionServerNameFromConfig | The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be ‘sql-logical-server-22092780.database.windows.net’; for an Azure SQL managed instance in the Azure commercial cloud, the value might be ‘sql-mi-39441134.767d5869f605.database.windows.net’. Port number and instance name must be specified separately. | genruntime.ConfigMapReference Optional |
| readIntent | Set to true to monitor a high availability replica of specified target, if any. | bool Optional |
| sqlEpResourceReference | The Azure resource ID of an Azure SQL DB elastic pool target. | genruntime.ResourceReference Required |
| targetAuthenticationType | The type of authentication to use when connecting to a target. | TargetAuthenticationType Required |
| targetType | Discriminator property for TargetProperties. | SqlDbElasticPoolTargetProperties_TargetType Required |
| targetVault | To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored. | VaultSecret Optional |
SqlDbElasticPoolTargetProperties_STATUS
Used by: TargetProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| anchorDatabaseResourceId | The Azure resource ID of the anchor database used to connect to an elastic pool. | string Optional |
| connectionServerName | The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be ‘sql-logical-server-22092780.database.windows.net’; for an Azure SQL managed instance in the Azure commercial cloud, the value might be ‘sql-mi-39441134.767d5869f605.database.windows.net’. Port number and instance name must be specified separately. | string Optional |
| provisioningState | The provisioning state of the resource. | AzureResourceManagerResourceProvisioningState_STATUS Optional |
| readIntent | Set to true to monitor a high availability replica of specified target, if any. | bool Optional |
| sqlEpResourceId | The Azure resource ID of an Azure SQL DB elastic pool target. | string Optional |
| targetAuthenticationType | The type of authentication to use when connecting to a target. | TargetAuthenticationType_STATUS Optional |
| targetType | Discriminator property for TargetProperties. | SqlDbElasticPoolTargetProperties_TargetType_STATUS Optional |
| targetVault | To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored. | VaultSecret_STATUS Optional |
SqlDbSingleDatabaseTargetProperties
Used by: TargetProperties.
| Property | Description | Type |
|---|---|---|
| connectionServerName | The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be ‘sql-logical-server-22092780.database.windows.net’; for an Azure SQL managed instance in the Azure commercial cloud, the value might be ‘sql-mi-39441134.767d5869f605.database.windows.net’. Port number and instance name must be specified separately. | string Optional |
| connectionServerNameFromConfig | The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be ‘sql-logical-server-22092780.database.windows.net’; for an Azure SQL managed instance in the Azure commercial cloud, the value might be ‘sql-mi-39441134.767d5869f605.database.windows.net’. Port number and instance name must be specified separately. | genruntime.ConfigMapReference Optional |
| readIntent | Set to true to monitor a high availability replica of specified target, if any. | bool Optional |
| sqlDbResourceReference | The Azure resource ID of an Azure SQL DB database target. | genruntime.ResourceReference Required |
| targetAuthenticationType | The type of authentication to use when connecting to a target. | TargetAuthenticationType Required |
| targetType | Discriminator property for TargetProperties. | SqlDbSingleDatabaseTargetProperties_TargetType Required |
| targetVault | To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored. | VaultSecret Optional |
SqlDbSingleDatabaseTargetProperties_STATUS
Used by: TargetProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| connectionServerName | The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be ‘sql-logical-server-22092780.database.windows.net’; for an Azure SQL managed instance in the Azure commercial cloud, the value might be ‘sql-mi-39441134.767d5869f605.database.windows.net’. Port number and instance name must be specified separately. | string Optional |
| provisioningState | The provisioning state of the resource. | AzureResourceManagerResourceProvisioningState_STATUS Optional |
| readIntent | Set to true to monitor a high availability replica of specified target, if any. | bool Optional |
| sqlDbResourceId | The Azure resource ID of an Azure SQL DB database target. | string Optional |
| targetAuthenticationType | The type of authentication to use when connecting to a target. | TargetAuthenticationType_STATUS Optional |
| targetType | Discriminator property for TargetProperties. | SqlDbSingleDatabaseTargetProperties_TargetType_STATUS Optional |
| targetVault | To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored. | VaultSecret_STATUS Optional |
SqlMiTargetProperties
Used by: TargetProperties.
| Property | Description | Type |
|---|---|---|
| connectionServerName | The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be ‘sql-logical-server-22092780.database.windows.net’; for an Azure SQL managed instance in the Azure commercial cloud, the value might be ‘sql-mi-39441134.767d5869f605.database.windows.net’. Port number and instance name must be specified separately. | string Optional |
| connectionServerNameFromConfig | The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be ‘sql-logical-server-22092780.database.windows.net’; for an Azure SQL managed instance in the Azure commercial cloud, the value might be ‘sql-mi-39441134.767d5869f605.database.windows.net’. Port number and instance name must be specified separately. | genruntime.ConfigMapReference Optional |
| connectionTcpPort | The TCP port number to optionally use in the connection string when connecting to an Azure SQL Managed Instance target. | int Optional |
| readIntent | Set to true to monitor a high availability replica of specified target, if any. | bool Optional |
| sqlMiResourceReference | The Azure resource ID of an Azure SQL Managed Instance target. | genruntime.ResourceReference Required |
| targetAuthenticationType | The type of authentication to use when connecting to a target. | TargetAuthenticationType Required |
| targetType | Discriminator property for TargetProperties. | SqlMiTargetProperties_TargetType Required |
| targetVault | To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored. | VaultSecret Optional |
SqlMiTargetProperties_STATUS
Used by: TargetProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| connectionServerName | The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be ‘sql-logical-server-22092780.database.windows.net’; for an Azure SQL managed instance in the Azure commercial cloud, the value might be ‘sql-mi-39441134.767d5869f605.database.windows.net’. Port number and instance name must be specified separately. | string Optional |
| connectionTcpPort | The TCP port number to optionally use in the connection string when connecting to an Azure SQL Managed Instance target. | int Optional |
| provisioningState | The provisioning state of the resource. | AzureResourceManagerResourceProvisioningState_STATUS Optional |
| readIntent | Set to true to monitor a high availability replica of specified target, if any. | bool Optional |
| sqlMiResourceId | The Azure resource ID of an Azure SQL Managed Instance target. | string Optional |
| targetAuthenticationType | The type of authentication to use when connecting to a target. | TargetAuthenticationType_STATUS Optional |
| targetType | Discriminator property for TargetProperties. | SqlMiTargetProperties_TargetType_STATUS Optional |
| targetVault | To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored. | VaultSecret_STATUS Optional |
SqlVmTargetProperties
Used by: TargetProperties.
| Property | Description | Type |
|---|---|---|
| connectionServerName | The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be ‘sql-logical-server-22092780.database.windows.net’; for an Azure SQL managed instance in the Azure commercial cloud, the value might be ‘sql-mi-39441134.767d5869f605.database.windows.net’. Port number and instance name must be specified separately. | string Optional |
| connectionServerNameFromConfig | The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be ‘sql-logical-server-22092780.database.windows.net’; for an Azure SQL managed instance in the Azure commercial cloud, the value might be ‘sql-mi-39441134.767d5869f605.database.windows.net’. Port number and instance name must be specified separately. | genruntime.ConfigMapReference Optional |
| connectionTcpPort | The TCP port number to optionally use in the connection string when connecting to an Azure SQL VM target. | int Optional |
| sqlNamedInstanceName | The SQL instance name to optionally use in the connection string when connecting to an Azure SQL VM target. | string Optional |
| sqlVmResourceReference | The Azure resource ID of an Azure SQL VM target. | genruntime.ResourceReference Required |
| targetAuthenticationType | The type of authentication to use when connecting to a target. | TargetAuthenticationType Required |
| targetType | Discriminator property for TargetProperties. | SqlVmTargetProperties_TargetType Required |
| targetVault | To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored. | VaultSecret Optional |
SqlVmTargetProperties_STATUS
Used by: TargetProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| connectionServerName | The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be ‘sql-logical-server-22092780.database.windows.net’; for an Azure SQL managed instance in the Azure commercial cloud, the value might be ‘sql-mi-39441134.767d5869f605.database.windows.net’. Port number and instance name must be specified separately. | string Optional |
| connectionTcpPort | The TCP port number to optionally use in the connection string when connecting to an Azure SQL VM target. | int Optional |
| provisioningState | The provisioning state of the resource. | AzureResourceManagerResourceProvisioningState_STATUS Optional |
| sqlNamedInstanceName | The SQL instance name to optionally use in the connection string when connecting to an Azure SQL VM target. | string Optional |
| sqlVmResourceId | The Azure resource ID of an Azure SQL VM target. | string Optional |
| targetAuthenticationType | The type of authentication to use when connecting to a target. | TargetAuthenticationType_STATUS Optional |
| targetType | Discriminator property for TargetProperties. | SqlVmTargetProperties_TargetType_STATUS Optional |
| targetVault | To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored. | VaultSecret_STATUS 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” |
UserAssignedIdentity_STATUS
User assigned identity properties
Used by: ManagedServiceIdentity_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | The client ID of the assigned identity. | string Optional |
| principalId | The principal ID of the assigned identity. | string Optional |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: ManagedServiceIdentity.
| Property | Description | Type |
|---|---|---|
| reference | genruntime.ResourceReference Optional |
SqlDbElasticPoolTargetProperties_TargetType
Used by: SqlDbElasticPoolTargetProperties.
| Value | Description |
|---|---|
| “SqlEp” |
SqlDbElasticPoolTargetProperties_TargetType_STATUS
Used by: SqlDbElasticPoolTargetProperties_STATUS.
| Value | Description |
|---|---|
| “SqlEp” |
SqlDbSingleDatabaseTargetProperties_TargetType
Used by: SqlDbSingleDatabaseTargetProperties.
| Value | Description |
|---|---|
| “SqlDb” |
SqlDbSingleDatabaseTargetProperties_TargetType_STATUS
Used by: SqlDbSingleDatabaseTargetProperties_STATUS.
| Value | Description |
|---|---|
| “SqlDb” |
SqlMiTargetProperties_TargetType
Used by: SqlMiTargetProperties.
| Value | Description |
|---|---|
| “SqlMi” |
SqlMiTargetProperties_TargetType_STATUS
Used by: SqlMiTargetProperties_STATUS.
| Value | Description |
|---|---|
| “SqlMi” |
SqlVmTargetProperties_TargetType
Used by: SqlVmTargetProperties.
| Value | Description |
|---|---|
| “SqlVm” |
SqlVmTargetProperties_TargetType_STATUS
Used by: SqlVmTargetProperties_STATUS.
| Value | Description |
|---|---|
| “SqlVm” |
TargetAuthenticationType
The type of authentication to use when connecting to a target.
Used by: SqlDbElasticPoolTargetProperties, SqlDbSingleDatabaseTargetProperties, SqlMiTargetProperties, and SqlVmTargetProperties.
| Value | Description |
|---|---|
| “Aad” | |
| “Sql” |
TargetAuthenticationType_STATUS
The type of authentication to use when connecting to a target.
Used by: SqlDbElasticPoolTargetProperties_STATUS, SqlDbSingleDatabaseTargetProperties_STATUS, SqlMiTargetProperties_STATUS, and SqlVmTargetProperties_STATUS.
| Value | Description |
|---|---|
| “Aad” | |
| “Sql” |
VaultSecret
The vault specific details required if using SQL authentication to connect to a target.
Used by: SqlDbElasticPoolTargetProperties, SqlDbSingleDatabaseTargetProperties, SqlMiTargetProperties, and SqlVmTargetProperties.
| Property | Description | Type |
|---|---|---|
| akvResourceReference | The Azure resource ID of the Key Vault instance storing database authentication secrets. | genruntime.ResourceReference Optional |
| akvTargetPassword | The path to the Key Vault secret storing the password for authentication to a target. | string Optional |
| akvTargetUser | The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target. | string Optional |
VaultSecret_STATUS
The vault specific details required if using SQL authentication to connect to a target.
Used by: SqlDbElasticPoolTargetProperties_STATUS, SqlDbSingleDatabaseTargetProperties_STATUS, SqlMiTargetProperties_STATUS, and SqlVmTargetProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| akvResourceId | The Azure resource ID of the Key Vault instance storing database authentication secrets. | string Optional |
| akvTargetPassword | The path to the Key Vault secret storing the password for authentication to a target. | string Optional |
| akvTargetUser | The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target. | string Optional |