sql.azure.com/v1api20211101

sql.azure.com/v1api20211101

Package v1api20211101 contains API Schema definitions for the sql v1api20211101 API group

Resource Types:

    APIVersion (string alias)

    Value Description

    "2021-11-01"

    AdministratorProperties_ARM

    (Appears on:Servers_Administrator_Spec_ARM)

    Properties of a active directory administrator.

    Field Description
    administratorType
    AdministratorProperties_AdministratorType_ARM

    AdministratorType: Type of the sever administrator.

    login
    string

    Login: Login name of the server administrator.

    sid
    string

    Sid: SID (object ID) of the server administrator.

    tenantId
    string

    TenantId: Tenant ID of the administrator.

    AdministratorProperties_AdministratorType (string alias)

    (Appears on:Servers_Administrator_Spec)

    Value Description

    "ActiveDirectory"

    AdministratorProperties_AdministratorType_ARM (string alias)

    (Appears on:AdministratorProperties_ARM)

    Value Description

    "ActiveDirectory"

    AdministratorProperties_AdministratorType_STATUS (string alias)

    (Appears on:Servers_Administrator_STATUS)

    Value Description

    "ActiveDirectory"

    AdministratorProperties_AdministratorType_STATUS_ARM (string alias)

    (Appears on:AdministratorProperties_STATUS_ARM)

    Value Description

    "ActiveDirectory"

    AdministratorProperties_STATUS_ARM

    (Appears on:Servers_Administrator_STATUS_ARM)

    Properties of a active directory administrator.

    Field Description
    administratorType
    AdministratorProperties_AdministratorType_STATUS_ARM

    AdministratorType: Type of the sever administrator.

    azureADOnlyAuthentication
    bool

    AzureADOnlyAuthentication: Azure Active Directory only Authentication enabled.

    login
    string

    Login: Login name of the server administrator.

    sid
    string

    Sid: SID (object ID) of the server administrator.

    tenantId
    string

    TenantId: Tenant ID of the administrator.

    AdvancedThreatProtectionProperties_ARM

    (Appears on:Servers_AdvancedThreatProtectionSetting_Spec_ARM, Servers_Databases_AdvancedThreatProtectionSetting_Spec_ARM)

    Properties of an Advanced Threat Protection state.

    Field Description
    state
    AdvancedThreatProtectionProperties_State_ARM

    State: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server.

    AdvancedThreatProtectionProperties_STATUS_ARM

    (Appears on:Servers_AdvancedThreatProtectionSetting_STATUS_ARM, Servers_Databases_AdvancedThreatProtectionSetting_STATUS_ARM)

    Properties of an Advanced Threat Protection state.

    Field Description
    creationTime
    string

    CreationTime: Specifies the UTC creation time of the policy.

    state
    AdvancedThreatProtectionProperties_State_STATUS_ARM

    State: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server.

    AdvancedThreatProtectionProperties_State (string alias)

    (Appears on:Servers_AdvancedThreatProtectionSetting_Spec, Servers_Databases_AdvancedThreatProtectionSetting_Spec)

    Value Description

    "Disabled"

    "Enabled"

    "New"

    AdvancedThreatProtectionProperties_State_ARM (string alias)

    (Appears on:AdvancedThreatProtectionProperties_ARM)

    Value Description

    "Disabled"

    "Enabled"

    "New"

    AdvancedThreatProtectionProperties_State_STATUS (string alias)

    (Appears on:Servers_AdvancedThreatProtectionSetting_STATUS, Servers_Databases_AdvancedThreatProtectionSetting_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    "New"

    AdvancedThreatProtectionProperties_State_STATUS_ARM (string alias)

    (Appears on:AdvancedThreatProtectionProperties_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    "New"

    AzureADOnlyAuthProperties_ARM

    (Appears on:Servers_AzureADOnlyAuthentication_Spec_ARM)

    Properties of a active directory only authentication.

    Field Description
    azureADOnlyAuthentication
    bool

    AzureADOnlyAuthentication: Azure Active Directory only Authentication enabled.

    AzureADOnlyAuthProperties_STATUS_ARM

    (Appears on:Servers_AzureADOnlyAuthentication_STATUS_ARM)

    Properties of a active directory only authentication.

    Field Description
    azureADOnlyAuthentication
    bool

    AzureADOnlyAuthentication: Azure Active Directory only Authentication enabled.

    BackupShortTermRetentionPolicyProperties_ARM

    (Appears on:Servers_Databases_BackupShortTermRetentionPolicy_Spec_ARM)

    Properties of a short term retention policy

    Field Description
    diffBackupIntervalInHours
    BackupShortTermRetentionPolicyProperties_DiffBackupIntervalInHours_ARM

    DiffBackupIntervalInHours: The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases.

    retentionDays
    int

    RetentionDays: The backup retention period in days. This is how many days Point-in-Time Restore will be supported.

    BackupShortTermRetentionPolicyProperties_DiffBackupIntervalInHours (int alias)

    (Appears on:Servers_Databases_BackupShortTermRetentionPolicy_Spec)

    Value Description

    12

    24

    BackupShortTermRetentionPolicyProperties_DiffBackupIntervalInHours_ARM (int alias)

    (Appears on:BackupShortTermRetentionPolicyProperties_ARM)

    Value Description

    12

    24

    BackupShortTermRetentionPolicyProperties_DiffBackupIntervalInHours_STATUS (int alias)

    (Appears on:Servers_Databases_BackupShortTermRetentionPolicy_STATUS)

    Value Description

    12

    24

    BackupShortTermRetentionPolicyProperties_DiffBackupIntervalInHours_STATUS_ARM (int alias)

    (Appears on:BackupShortTermRetentionPolicyProperties_STATUS_ARM)

    Value Description

    12

    24

    BackupShortTermRetentionPolicyProperties_STATUS_ARM

    (Appears on:Servers_Databases_BackupShortTermRetentionPolicy_STATUS_ARM)

    Properties of a short term retention policy

    Field Description
    diffBackupIntervalInHours
    BackupShortTermRetentionPolicyProperties_DiffBackupIntervalInHours_STATUS_ARM

    DiffBackupIntervalInHours: The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases.

    retentionDays
    int

    RetentionDays: The backup retention period in days. This is how many days Point-in-Time Restore will be supported.

    BaseLongTermRetentionPolicyProperties_ARM

    (Appears on:Servers_Databases_BackupLongTermRetentionPolicy_Spec_ARM)

    Properties of a long term retention policy

    Field Description
    monthlyRetention
    string

    MonthlyRetention: The monthly retention policy for an LTR backup in an ISO 8601 format.

    weekOfYear
    int

    WeekOfYear: The week of year to take the yearly backup in an ISO 8601 format.

    weeklyRetention
    string

    WeeklyRetention: The weekly retention policy for an LTR backup in an ISO 8601 format.

    yearlyRetention
    string

    YearlyRetention: The yearly retention policy for an LTR backup in an ISO 8601 format.

    BaseLongTermRetentionPolicyProperties_STATUS_ARM

    (Appears on:Servers_Databases_BackupLongTermRetentionPolicy_STATUS_ARM)

    Properties of a long term retention policy

    Field Description
    monthlyRetention
    string

    MonthlyRetention: The monthly retention policy for an LTR backup in an ISO 8601 format.

    weekOfYear
    int

    WeekOfYear: The week of year to take the yearly backup in an ISO 8601 format.

    weeklyRetention
    string

    WeeklyRetention: The weekly retention policy for an LTR backup in an ISO 8601 format.

    yearlyRetention
    string

    YearlyRetention: The yearly retention policy for an LTR backup in an ISO 8601 format.

    DatabaseBlobAuditingPolicyProperties_ARM

    (Appears on:Servers_Databases_AuditingSetting_Spec_ARM)

    Properties of a database blob auditing policy.

    Field Description
    auditActionsAndGroups
    []string

    AuditActionsAndGroups: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see Database-Level Audit Action Groups. For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see Database-Level Audit Actions

    isAzureMonitorTargetEnabled
    bool

    IsAzureMonitorTargetEnabled: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘State’ as ‘Enabled’ and ‘IsAzureMonitorTargetEnabled’ as true. When using REST API to configure auditing, Diagnostic Settings with ‘SQLSecurityAuditEvents’ diagnostic logs category on the database should be also created. Note that for server level audit you should use the ‘master’ database as {databaseName}. Diagnostic Settings URI format: PUT https:/​/​management.azure.com/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroup}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​{databaseName}/​providers/​microsoft.insights/​diagnosticSettings/​{settingsName}?api-version=2017-05-01-preview For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

    isManagedIdentityInUse
    bool

    IsManagedIdentityInUse: Specifies whether Managed Identity is used to access blob storage

    isStorageSecondaryKeyInUse
    bool

    IsStorageSecondaryKeyInUse: Specifies whether storageAccountAccessKey value is the storage’s secondary key.

    queueDelayMs
    int

    QueueDelayMs: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.

    retentionDays
    int

    RetentionDays: Specifies the number of days to keep in the audit logs in the storage account.

    state
    DatabaseBlobAuditingPolicyProperties_State_ARM

    State: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.

    storageAccountAccessKey
    string

    StorageAccountAccessKey: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding ‘Storage Blob Data Contributor’ RBAC role to the server identity. For more information, see Auditing to storage using Managed Identity authentication

    storageAccountSubscriptionId
    string

    StorageAccountSubscriptionId: Specifies the blob storage subscription Id.

    storageEndpoint
    string

    StorageEndpoint: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.

    DatabaseBlobAuditingPolicyProperties_STATUS_ARM

    (Appears on:Servers_Databases_AuditingSetting_STATUS_ARM)

    Properties of a database blob auditing policy.

    Field Description
    auditActionsAndGroups
    []string

    AuditActionsAndGroups: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see Database-Level Audit Action Groups. For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see Database-Level Audit Actions

    isAzureMonitorTargetEnabled
    bool

    IsAzureMonitorTargetEnabled: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘State’ as ‘Enabled’ and ‘IsAzureMonitorTargetEnabled’ as true. When using REST API to configure auditing, Diagnostic Settings with ‘SQLSecurityAuditEvents’ diagnostic logs category on the database should be also created. Note that for server level audit you should use the ‘master’ database as {databaseName}. Diagnostic Settings URI format: PUT https:/​/​management.azure.com/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroup}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​{databaseName}/​providers/​microsoft.insights/​diagnosticSettings/​{settingsName}?api-version=2017-05-01-preview For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

    isManagedIdentityInUse
    bool

    IsManagedIdentityInUse: Specifies whether Managed Identity is used to access blob storage

    isStorageSecondaryKeyInUse
    bool

    IsStorageSecondaryKeyInUse: Specifies whether storageAccountAccessKey value is the storage’s secondary key.

    queueDelayMs
    int

    QueueDelayMs: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.

    retentionDays
    int

    RetentionDays: Specifies the number of days to keep in the audit logs in the storage account.

    state
    DatabaseBlobAuditingPolicyProperties_State_STATUS_ARM

    State: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.

    storageAccountSubscriptionId
    string

    StorageAccountSubscriptionId: Specifies the blob storage subscription Id.

    storageEndpoint
    string

    StorageEndpoint: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.

    DatabaseBlobAuditingPolicyProperties_State (string alias)

    (Appears on:Servers_Databases_AuditingSetting_Spec)

    Value Description

    "Disabled"

    "Enabled"

    DatabaseBlobAuditingPolicyProperties_State_ARM (string alias)

    (Appears on:DatabaseBlobAuditingPolicyProperties_ARM)

    Value Description

    "Disabled"

    "Enabled"

    DatabaseBlobAuditingPolicyProperties_State_STATUS (string alias)

    (Appears on:Servers_Databases_AuditingSetting_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    DatabaseBlobAuditingPolicyProperties_State_STATUS_ARM (string alias)

    (Appears on:DatabaseBlobAuditingPolicyProperties_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    DatabaseIdentity

    (Appears on:Servers_Database_Spec)

    Azure Active Directory identity configuration for a resource.

    Field Description
    type
    DatabaseIdentity_Type

    Type: The identity type

    userAssignedIdentities
    []UserAssignedIdentityDetails

    UserAssignedIdentities: The resource ids of the user assigned identities to use

    DatabaseIdentity_ARM

    (Appears on:Servers_Database_Spec_ARM)

    Azure Active Directory identity configuration for a resource.

    Field Description
    type
    DatabaseIdentity_Type_ARM

    Type: The identity type

    userAssignedIdentities
    map[string]./api/sql/v1api20211101.UserAssignedIdentityDetails_ARM

    DatabaseIdentity_STATUS

    (Appears on:Servers_Database_STATUS)

    Azure Active Directory identity configuration for a resource.

    Field Description
    tenantId
    string

    TenantId: The Azure Active Directory tenant id.

    type
    DatabaseIdentity_Type_STATUS

    Type: The identity type

    userAssignedIdentities
    map[string]./api/sql/v1api20211101.DatabaseUserIdentity_STATUS

    UserAssignedIdentities: The resource ids of the user assigned identities to use

    DatabaseIdentity_STATUS_ARM

    (Appears on:Servers_Database_STATUS_ARM)

    Azure Active Directory identity configuration for a resource.

    Field Description
    tenantId
    string

    TenantId: The Azure Active Directory tenant id.

    type
    DatabaseIdentity_Type_STATUS_ARM

    Type: The identity type

    userAssignedIdentities
    map[string]./api/sql/v1api20211101.DatabaseUserIdentity_STATUS_ARM

    UserAssignedIdentities: The resource ids of the user assigned identities to use

    DatabaseIdentity_Type (string alias)

    (Appears on:DatabaseIdentity)

    Value Description

    "None"

    "UserAssigned"

    DatabaseIdentity_Type_ARM (string alias)

    (Appears on:DatabaseIdentity_ARM)

    Value Description

    "None"

    "UserAssigned"

    DatabaseIdentity_Type_STATUS (string alias)

    (Appears on:DatabaseIdentity_STATUS)

    Value Description

    "None"

    "UserAssigned"

    DatabaseIdentity_Type_STATUS_ARM (string alias)

    (Appears on:DatabaseIdentity_STATUS_ARM)

    Value Description

    "None"

    "UserAssigned"

    DatabaseProperties_ARM

    (Appears on:Servers_Database_Spec_ARM)

    The database’s properties.

    Field Description
    autoPauseDelay
    int

    AutoPauseDelay: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled

    catalogCollation
    DatabaseProperties_CatalogCollation_ARM

    CatalogCollation: Collation of the metadata catalog.

    collation
    string

    Collation: The collation of the database.

    createMode
    DatabaseProperties_CreateMode_ARM

    CreateMode: Specifies the mode of database creation. Default: regular database creation. Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database. Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database. PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified. Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore. Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database’s original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time. RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID. Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition.

    elasticPoolId
    string
    federatedClientId
    string

    FederatedClientId: The Client id used for cross tenant per database CMK scenario

    highAvailabilityReplicaCount
    int

    HighAvailabilityReplicaCount: The number of secondary replicas associated with the database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool.

    isLedgerOn
    bool

    IsLedgerOn: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.

    licenseType
    DatabaseProperties_LicenseType_ARM

    LicenseType: The license type to apply for this database. LicenseIncluded if you need a license, or BasePrice if you have a license and are eligible for the Azure Hybrid Benefit.

    longTermRetentionBackupResourceId
    string
    maintenanceConfigurationId
    string

    MaintenanceConfigurationId: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.

    maxSizeBytes
    int

    MaxSizeBytes: The max size of the database expressed in bytes.

    minCapacity
    float64

    MinCapacity: Minimal capacity that database will always have allocated, if not paused

    readScale
    DatabaseProperties_ReadScale_ARM

    ReadScale: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool.

    recoverableDatabaseId
    string
    recoveryServicesRecoveryPointId
    string
    requestedBackupStorageRedundancy
    DatabaseProperties_RequestedBackupStorageRedundancy_ARM

    RequestedBackupStorageRedundancy: The storage account type to be used to store backups for this database.

    restorableDroppedDatabaseId
    string
    restorePointInTime
    string

    RestorePointInTime: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.

    sampleName
    DatabaseProperties_SampleName_ARM

    SampleName: The name of the sample schema to apply when creating this database.

    secondaryType
    DatabaseProperties_SecondaryType_ARM

    SecondaryType: The secondary type of the database if it is a secondary. Valid values are Geo and Named.

    sourceDatabaseDeletionDate
    string

    SourceDatabaseDeletionDate: Specifies the time that the database was deleted.

    sourceDatabaseId
    string
    sourceResourceId
    string
    zoneRedundant
    bool

    ZoneRedundant: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.

    DatabaseProperties_CatalogCollation (string alias)

    (Appears on:Servers_Database_Spec)

    Value Description

    "DATABASE_DEFAULT"

    "SQL_Latin1_General_CP1_CI_AS"

    DatabaseProperties_CatalogCollation_ARM (string alias)

    (Appears on:DatabaseProperties_ARM)

    Value Description

    "DATABASE_DEFAULT"

    "SQL_Latin1_General_CP1_CI_AS"

    DatabaseProperties_CatalogCollation_STATUS (string alias)

    (Appears on:Servers_Database_STATUS)

    Value Description

    "DATABASE_DEFAULT"

    "SQL_Latin1_General_CP1_CI_AS"

    DatabaseProperties_CatalogCollation_STATUS_ARM (string alias)

    (Appears on:DatabaseProperties_STATUS_ARM)

    Value Description

    "DATABASE_DEFAULT"

    "SQL_Latin1_General_CP1_CI_AS"

    DatabaseProperties_CreateMode (string alias)

    (Appears on:Servers_Database_Spec)

    Value Description

    "Copy"

    "Default"

    "OnlineSecondary"

    "PointInTimeRestore"

    "Recovery"

    "Restore"

    "RestoreExternalBackup"

    "RestoreExternalBackupSecondary"

    "RestoreLongTermRetentionBackup"

    "Secondary"

    DatabaseProperties_CreateMode_ARM (string alias)

    (Appears on:DatabaseProperties_ARM)

    Value Description

    "Copy"

    "Default"

    "OnlineSecondary"

    "PointInTimeRestore"

    "Recovery"

    "Restore"

    "RestoreExternalBackup"

    "RestoreExternalBackupSecondary"

    "RestoreLongTermRetentionBackup"

    "Secondary"

    DatabaseProperties_CreateMode_STATUS (string alias)

    (Appears on:Servers_Database_STATUS)

    Value Description

    "Copy"

    "Default"

    "OnlineSecondary"

    "PointInTimeRestore"

    "Recovery"

    "Restore"

    "RestoreExternalBackup"

    "RestoreExternalBackupSecondary"

    "RestoreLongTermRetentionBackup"

    "Secondary"

    DatabaseProperties_CreateMode_STATUS_ARM (string alias)

    (Appears on:DatabaseProperties_STATUS_ARM)

    Value Description

    "Copy"

    "Default"

    "OnlineSecondary"

    "PointInTimeRestore"

    "Recovery"

    "Restore"

    "RestoreExternalBackup"

    "RestoreExternalBackupSecondary"

    "RestoreLongTermRetentionBackup"

    "Secondary"

    DatabaseProperties_CurrentBackupStorageRedundancy_STATUS (string alias)

    (Appears on:Servers_Database_STATUS)

    Value Description

    "Geo"

    "GeoZone"

    "Local"

    "Zone"

    DatabaseProperties_CurrentBackupStorageRedundancy_STATUS_ARM (string alias)

    (Appears on:DatabaseProperties_STATUS_ARM)

    Value Description

    "Geo"

    "GeoZone"

    "Local"

    "Zone"

    DatabaseProperties_LicenseType (string alias)

    (Appears on:Servers_Database_Spec)

    Value Description

    "BasePrice"

    "LicenseIncluded"

    DatabaseProperties_LicenseType_ARM (string alias)

    (Appears on:DatabaseProperties_ARM)

    Value Description

    "BasePrice"

    "LicenseIncluded"

    DatabaseProperties_LicenseType_STATUS (string alias)

    (Appears on:Servers_Database_STATUS)

    Value Description

    "BasePrice"

    "LicenseIncluded"

    DatabaseProperties_LicenseType_STATUS_ARM (string alias)

    (Appears on:DatabaseProperties_STATUS_ARM)

    Value Description

    "BasePrice"

    "LicenseIncluded"

    DatabaseProperties_ReadScale (string alias)

    (Appears on:Servers_Database_Spec)

    Value Description

    "Disabled"

    "Enabled"

    DatabaseProperties_ReadScale_ARM (string alias)

    (Appears on:DatabaseProperties_ARM)

    Value Description

    "Disabled"

    "Enabled"

    DatabaseProperties_ReadScale_STATUS (string alias)

    (Appears on:Servers_Database_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    DatabaseProperties_ReadScale_STATUS_ARM (string alias)

    (Appears on:DatabaseProperties_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    DatabaseProperties_RequestedBackupStorageRedundancy (string alias)

    (Appears on:Servers_Database_Spec)

    Value Description

    "Geo"

    "GeoZone"

    "Local"

    "Zone"

    DatabaseProperties_RequestedBackupStorageRedundancy_ARM (string alias)

    (Appears on:DatabaseProperties_ARM)

    Value Description

    "Geo"

    "GeoZone"

    "Local"

    "Zone"

    DatabaseProperties_RequestedBackupStorageRedundancy_STATUS (string alias)

    (Appears on:Servers_Database_STATUS)

    Value Description

    "Geo"

    "GeoZone"

    "Local"

    "Zone"

    DatabaseProperties_RequestedBackupStorageRedundancy_STATUS_ARM (string alias)

    (Appears on:DatabaseProperties_STATUS_ARM)

    Value Description

    "Geo"

    "GeoZone"

    "Local"

    "Zone"

    DatabaseProperties_STATUS_ARM

    (Appears on:Servers_Database_STATUS_ARM)

    The database’s properties.

    Field Description
    autoPauseDelay
    int

    AutoPauseDelay: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled

    catalogCollation
    DatabaseProperties_CatalogCollation_STATUS_ARM

    CatalogCollation: Collation of the metadata catalog.

    collation
    string

    Collation: The collation of the database.

    createMode
    DatabaseProperties_CreateMode_STATUS_ARM

    CreateMode: Specifies the mode of database creation. Default: regular database creation. Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database. Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database. PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified. Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore. Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database’s original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time. RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID. Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition.

    creationDate
    string

    CreationDate: The creation date of the database (ISO8601 format).

    currentBackupStorageRedundancy
    DatabaseProperties_CurrentBackupStorageRedundancy_STATUS_ARM

    CurrentBackupStorageRedundancy: The storage account type used to store backups for this database.

    currentServiceObjectiveName
    string

    CurrentServiceObjectiveName: The current service level objective name of the database.

    currentSku
    Sku_STATUS_ARM

    CurrentSku: The name and tier of the SKU.

    databaseId
    string

    DatabaseId: The ID of the database.

    defaultSecondaryLocation
    string

    DefaultSecondaryLocation: The default secondary region for this database.

    earliestRestoreDate
    string

    EarliestRestoreDate: This records the earliest start date and time that restore is available for this database (ISO8601 format).

    elasticPoolId
    string

    ElasticPoolId: The resource identifier of the elastic pool containing this database.

    failoverGroupId
    string

    FailoverGroupId: Failover Group resource identifier that this database belongs to.

    federatedClientId
    string

    FederatedClientId: The Client id used for cross tenant per database CMK scenario

    highAvailabilityReplicaCount
    int

    HighAvailabilityReplicaCount: The number of secondary replicas associated with the database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool.

    isInfraEncryptionEnabled
    bool

    IsInfraEncryptionEnabled: Infra encryption is enabled for this database.

    isLedgerOn
    bool

    IsLedgerOn: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.

    licenseType
    DatabaseProperties_LicenseType_STATUS_ARM

    LicenseType: The license type to apply for this database. LicenseIncluded if you need a license, or BasePrice if you have a license and are eligible for the Azure Hybrid Benefit.

    longTermRetentionBackupResourceId
    string

    LongTermRetentionBackupResourceId: The resource identifier of the long term retention backup associated with create operation of this database.

    maintenanceConfigurationId
    string

    MaintenanceConfigurationId: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.

    maxLogSizeBytes
    int

    MaxLogSizeBytes: The max log size for this database.

    maxSizeBytes
    int

    MaxSizeBytes: The max size of the database expressed in bytes.

    minCapacity
    float64

    MinCapacity: Minimal capacity that database will always have allocated, if not paused

    pausedDate
    string

    PausedDate: The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready.

    readScale
    DatabaseProperties_ReadScale_STATUS_ARM

    ReadScale: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool.

    recoverableDatabaseId
    string

    RecoverableDatabaseId: The resource identifier of the recoverable database associated with create operation of this database.

    recoveryServicesRecoveryPointId
    string

    RecoveryServicesRecoveryPointId: The resource identifier of the recovery point associated with create operation of this database.

    requestedBackupStorageRedundancy
    DatabaseProperties_RequestedBackupStorageRedundancy_STATUS_ARM

    RequestedBackupStorageRedundancy: The storage account type to be used to store backups for this database.

    requestedServiceObjectiveName
    string

    RequestedServiceObjectiveName: The requested service level objective name of the database.

    restorableDroppedDatabaseId
    string

    RestorableDroppedDatabaseId: The resource identifier of the restorable dropped database associated with create operation of this database.

    restorePointInTime
    string

    RestorePointInTime: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.

    resumedDate
    string

    ResumedDate: The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused.

    sampleName
    DatabaseProperties_SampleName_STATUS_ARM

    SampleName: The name of the sample schema to apply when creating this database.

    secondaryType
    DatabaseProperties_SecondaryType_STATUS_ARM

    SecondaryType: The secondary type of the database if it is a secondary. Valid values are Geo and Named.

    sourceDatabaseDeletionDate
    string

    SourceDatabaseDeletionDate: Specifies the time that the database was deleted.

    sourceDatabaseId
    string

    SourceDatabaseId: The resource identifier of the source database associated with create operation of this database.

    sourceResourceId
    string

    SourceResourceId: The resource identifier of the source associated with the create operation of this database. This property is only supported for DataWarehouse edition and allows to restore across subscriptions. When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of the existing database or existing sql pool, and restorePointInTime must be specified. When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant

    status
    DatabaseProperties_Status_STATUS_ARM

    Status: The status of the database.

    zoneRedundant
    bool

    ZoneRedundant: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.

    DatabaseProperties_SampleName (string alias)

    (Appears on:Servers_Database_Spec)

    Value Description

    "AdventureWorksLT"

    "WideWorldImportersFull"

    "WideWorldImportersStd"

    DatabaseProperties_SampleName_ARM (string alias)

    (Appears on:DatabaseProperties_ARM)

    Value Description

    "AdventureWorksLT"

    "WideWorldImportersFull"

    "WideWorldImportersStd"

    DatabaseProperties_SampleName_STATUS (string alias)

    (Appears on:Servers_Database_STATUS)

    Value Description

    "AdventureWorksLT"

    "WideWorldImportersFull"

    "WideWorldImportersStd"

    DatabaseProperties_SampleName_STATUS_ARM (string alias)

    (Appears on:DatabaseProperties_STATUS_ARM)

    Value Description

    "AdventureWorksLT"

    "WideWorldImportersFull"

    "WideWorldImportersStd"

    DatabaseProperties_SecondaryType (string alias)

    (Appears on:Servers_Database_Spec)

    Value Description

    "Geo"

    "Named"

    DatabaseProperties_SecondaryType_ARM (string alias)

    (Appears on:DatabaseProperties_ARM)

    Value Description

    "Geo"

    "Named"

    DatabaseProperties_SecondaryType_STATUS (string alias)

    (Appears on:Servers_Database_STATUS)

    Value Description

    "Geo"

    "Named"

    DatabaseProperties_SecondaryType_STATUS_ARM (string alias)

    (Appears on:DatabaseProperties_STATUS_ARM)

    Value Description

    "Geo"

    "Named"

    DatabaseProperties_Status_STATUS (string alias)

    (Appears on:Servers_Database_STATUS)

    Value Description

    "AutoClosed"

    "Copying"

    "Creating"

    "Disabled"

    "EmergencyMode"

    "Inaccessible"

    "Offline"

    "OfflineChangingDwPerformanceTiers"

    "OfflineSecondary"

    "Online"

    "OnlineChangingDwPerformanceTiers"

    "Paused"

    "Pausing"

    "Recovering"

    "RecoveryPending"

    "Restoring"

    "Resuming"

    "Scaling"

    "Shutdown"

    "Standby"

    "Starting"

    "Stopped"

    "Stopping"

    "Suspect"

    DatabaseProperties_Status_STATUS_ARM (string alias)

    (Appears on:DatabaseProperties_STATUS_ARM)

    Value Description

    "AutoClosed"

    "Copying"

    "Creating"

    "Disabled"

    "EmergencyMode"

    "Inaccessible"

    "Offline"

    "OfflineChangingDwPerformanceTiers"

    "OfflineSecondary"

    "Online"

    "OnlineChangingDwPerformanceTiers"

    "Paused"

    "Pausing"

    "Recovering"

    "RecoveryPending"

    "Restoring"

    "Resuming"

    "Scaling"

    "Shutdown"

    "Standby"

    "Starting"

    "Stopped"

    "Stopping"

    "Suspect"

    DatabaseSecurityAlertPoliciesSecurityAlertsPolicyProperties_ARM

    (Appears on:Servers_Databases_SecurityAlertPolicy_Spec_ARM)

    Properties of a security alert policy.

    Field Description
    disabledAlerts
    []string

    DisabledAlerts: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force

    emailAccountAdmins
    bool

    EmailAccountAdmins: Specifies that the alert is sent to the account administrators.

    emailAddresses
    []string

    EmailAddresses: Specifies an array of e-mail addresses to which the alert is sent.

    retentionDays
    int

    RetentionDays: Specifies the number of days to keep in the Threat Detection audit logs.

    state
    DatabaseSecurityAlertPoliciesSecurityAlertsPolicyProperties_State_ARM

    State: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.

    storageAccountAccessKey
    string

    StorageAccountAccessKey: Specifies the identifier key of the Threat Detection audit storage account.

    storageEndpoint
    string

    StorageEndpoint: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

    DatabaseSecurityAlertPoliciesSecurityAlertsPolicyProperties_STATUS_ARM

    (Appears on:Servers_Databases_SecurityAlertPolicy_STATUS_ARM)

    Properties of a security alert policy.

    Field Description
    creationTime
    string

    CreationTime: Specifies the UTC creation time of the policy.

    disabledAlerts
    []string

    DisabledAlerts: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force

    emailAccountAdmins
    bool

    EmailAccountAdmins: Specifies that the alert is sent to the account administrators.

    emailAddresses
    []string

    EmailAddresses: Specifies an array of e-mail addresses to which the alert is sent.

    retentionDays
    int

    RetentionDays: Specifies the number of days to keep in the Threat Detection audit logs.

    state
    DatabaseSecurityAlertPoliciesSecurityAlertsPolicyProperties_State_STATUS_ARM

    State: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.

    storageEndpoint
    string

    StorageEndpoint: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

    DatabaseSecurityAlertPoliciesSecurityAlertsPolicyProperties_State (string alias)

    (Appears on:Servers_Databases_SecurityAlertPolicy_Spec)

    Value Description

    "Disabled"

    "Enabled"

    DatabaseSecurityAlertPoliciesSecurityAlertsPolicyProperties_State_ARM (string alias)

    (Appears on:DatabaseSecurityAlertPoliciesSecurityAlertsPolicyProperties_ARM)

    Value Description

    "Disabled"

    "Enabled"

    DatabaseSecurityAlertPoliciesSecurityAlertsPolicyProperties_State_STATUS (string alias)

    (Appears on:Servers_Databases_SecurityAlertPolicy_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    DatabaseSecurityAlertPoliciesSecurityAlertsPolicyProperties_State_STATUS_ARM (string alias)

    (Appears on:DatabaseSecurityAlertPoliciesSecurityAlertsPolicyProperties_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    DatabaseUserIdentity_STATUS

    (Appears on:DatabaseIdentity_STATUS)

    Azure Active Directory identity configuration for a resource.

    Field Description
    clientId
    string

    ClientId: The Azure Active Directory client id.

    principalId
    string

    PrincipalId: The Azure Active Directory principal id.

    DatabaseUserIdentity_STATUS_ARM

    (Appears on:DatabaseIdentity_STATUS_ARM)

    Azure Active Directory identity configuration for a resource.

    Field Description
    clientId
    string

    ClientId: The Azure Active Directory client id.

    principalId
    string

    PrincipalId: The Azure Active Directory principal id.

    DatabaseVulnerabilityAssessmentsDatabaseVulnerabilityAssessmentProperties_ARM

    (Appears on:Servers_Databases_VulnerabilityAssessment_Spec_ARM)

    Properties of a database Vulnerability Assessment.

    Field Description
    recurringScans
    VulnerabilityAssessmentRecurringScansProperties_ARM

    RecurringScans: The recurring scans settings

    storageAccountAccessKey
    string

    StorageAccountAccessKey: Specifies the identifier key of the storage account for vulnerability assessment scan results. If ‘StorageContainerSasKey’ isn’t specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall

    storageContainerPath
    string

    StorageContainerPath: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn’t set

    storageContainerSasKey
    string

    StorageContainerSasKey: A shared access signature (SAS Key) that has write access to the blob container specified in ‘storageContainerPath’ parameter. If ‘storageAccountAccessKey’ isn’t specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall

    DatabaseVulnerabilityAssessmentsDatabaseVulnerabilityAssessmentProperties_STATUS_ARM

    (Appears on:Servers_Databases_VulnerabilityAssessment_STATUS_ARM)

    Properties of a database Vulnerability Assessment.

    Field Description
    recurringScans
    VulnerabilityAssessmentRecurringScansProperties_STATUS_ARM

    RecurringScans: The recurring scans settings

    storageContainerPath
    string

    StorageContainerPath: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn’t set

    ElasticPoolPerDatabaseSettings

    (Appears on:Servers_ElasticPool_Spec)

    Per database settings of an elastic pool.

    Field Description
    maxCapacity
    float64

    MaxCapacity: The maximum capacity any one database can consume.

    minCapacity
    float64

    MinCapacity: The minimum capacity all databases are guaranteed.

    ElasticPoolPerDatabaseSettings_ARM

    (Appears on:ElasticPoolProperties_ARM)

    Per database settings of an elastic pool.

    Field Description
    maxCapacity
    float64

    MaxCapacity: The maximum capacity any one database can consume.

    minCapacity
    float64

    MinCapacity: The minimum capacity all databases are guaranteed.

    ElasticPoolPerDatabaseSettings_STATUS

    (Appears on:Servers_ElasticPool_STATUS)

    Per database settings of an elastic pool.

    Field Description
    maxCapacity
    float64

    MaxCapacity: The maximum capacity any one database can consume.

    minCapacity
    float64

    MinCapacity: The minimum capacity all databases are guaranteed.

    ElasticPoolPerDatabaseSettings_STATUS_ARM

    (Appears on:ElasticPoolProperties_STATUS_ARM)

    Per database settings of an elastic pool.

    Field Description
    maxCapacity
    float64

    MaxCapacity: The maximum capacity any one database can consume.

    minCapacity
    float64

    MinCapacity: The minimum capacity all databases are guaranteed.

    ElasticPoolProperties_ARM

    (Appears on:Servers_ElasticPool_Spec_ARM)

    Properties of an elastic pool

    Field Description
    highAvailabilityReplicaCount
    int

    HighAvailabilityReplicaCount: The number of secondary replicas associated with the elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.

    licenseType
    ElasticPoolProperties_LicenseType_ARM

    LicenseType: The license type to apply for this elastic pool.

    maintenanceConfigurationId
    string

    MaintenanceConfigurationId: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.

    maxSizeBytes
    int

    MaxSizeBytes: The storage limit for the database elastic pool in bytes.

    minCapacity
    float64

    MinCapacity: Minimal capacity that serverless pool will not shrink below, if not paused

    perDatabaseSettings
    ElasticPoolPerDatabaseSettings_ARM

    PerDatabaseSettings: The per database settings for the elastic pool.

    zoneRedundant
    bool

    ZoneRedundant: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.

    ElasticPoolProperties_LicenseType (string alias)

    (Appears on:Servers_ElasticPool_Spec)

    Value Description

    "BasePrice"

    "LicenseIncluded"

    ElasticPoolProperties_LicenseType_ARM (string alias)

    (Appears on:ElasticPoolProperties_ARM)

    Value Description

    "BasePrice"

    "LicenseIncluded"

    ElasticPoolProperties_LicenseType_STATUS (string alias)

    (Appears on:Servers_ElasticPool_STATUS)

    Value Description

    "BasePrice"

    "LicenseIncluded"

    ElasticPoolProperties_LicenseType_STATUS_ARM (string alias)

    (Appears on:ElasticPoolProperties_STATUS_ARM)

    Value Description

    "BasePrice"

    "LicenseIncluded"

    ElasticPoolProperties_STATUS_ARM

    (Appears on:Servers_ElasticPool_STATUS_ARM)

    Properties of an elastic pool

    Field Description
    creationDate
    string

    CreationDate: The creation date of the elastic pool (ISO8601 format).

    highAvailabilityReplicaCount
    int

    HighAvailabilityReplicaCount: The number of secondary replicas associated with the elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.

    licenseType
    ElasticPoolProperties_LicenseType_STATUS_ARM

    LicenseType: The license type to apply for this elastic pool.

    maintenanceConfigurationId
    string

    MaintenanceConfigurationId: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.

    maxSizeBytes
    int

    MaxSizeBytes: The storage limit for the database elastic pool in bytes.

    minCapacity
    float64

    MinCapacity: Minimal capacity that serverless pool will not shrink below, if not paused

    perDatabaseSettings
    ElasticPoolPerDatabaseSettings_STATUS_ARM

    PerDatabaseSettings: The per database settings for the elastic pool.

    state
    ElasticPoolProperties_State_STATUS_ARM

    State: The state of the elastic pool.

    zoneRedundant
    bool

    ZoneRedundant: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.

    ElasticPoolProperties_State_STATUS (string alias)

    (Appears on:Servers_ElasticPool_STATUS)

    Value Description

    "Creating"

    "Disabled"

    "Ready"

    ElasticPoolProperties_State_STATUS_ARM (string alias)

    (Appears on:ElasticPoolProperties_STATUS_ARM)

    Value Description

    "Creating"

    "Disabled"

    "Ready"

    FailoverGroupProperties_ARM

    (Appears on:Servers_FailoverGroup_Spec_ARM)

    Properties of a failover group.

    Field Description
    databases
    []string
    partnerServers
    []PartnerInfo_ARM

    PartnerServers: List of partner server information for the failover group.

    readOnlyEndpoint
    FailoverGroupReadOnlyEndpoint_ARM

    ReadOnlyEndpoint: Read-only endpoint of the failover group instance.

    readWriteEndpoint
    FailoverGroupReadWriteEndpoint_ARM

    ReadWriteEndpoint: Read-write endpoint of the failover group instance.

    FailoverGroupProperties_ReplicationRole_STATUS (string alias)

    (Appears on:Servers_FailoverGroup_STATUS)

    Value Description

    "Primary"

    "Secondary"

    FailoverGroupProperties_ReplicationRole_STATUS_ARM (string alias)

    (Appears on:FailoverGroupProperties_STATUS_ARM)

    Value Description

    "Primary"

    "Secondary"

    FailoverGroupProperties_STATUS_ARM

    (Appears on:Servers_FailoverGroup_STATUS_ARM)

    Properties of a failover group.

    Field Description
    databases
    []string

    Databases: List of databases in the failover group.

    partnerServers
    []PartnerInfo_STATUS_ARM

    PartnerServers: List of partner server information for the failover group.

    readOnlyEndpoint
    FailoverGroupReadOnlyEndpoint_STATUS_ARM

    ReadOnlyEndpoint: Read-only endpoint of the failover group instance.

    readWriteEndpoint
    FailoverGroupReadWriteEndpoint_STATUS_ARM

    ReadWriteEndpoint: Read-write endpoint of the failover group instance.

    replicationRole
    FailoverGroupProperties_ReplicationRole_STATUS_ARM

    ReplicationRole: Local replication role of the failover group instance.

    replicationState
    string

    ReplicationState: Replication state of the failover group instance.

    FailoverGroupReadOnlyEndpoint

    (Appears on:Servers_FailoverGroup_Spec)

    Read-only endpoint of the failover group instance.

    Field Description
    failoverPolicy
    FailoverGroupReadOnlyEndpoint_FailoverPolicy

    FailoverPolicy: Failover policy of the read-only endpoint for the failover group.

    FailoverGroupReadOnlyEndpoint_ARM

    (Appears on:FailoverGroupProperties_ARM)

    Read-only endpoint of the failover group instance.

    Field Description
    failoverPolicy
    FailoverGroupReadOnlyEndpoint_FailoverPolicy_ARM

    FailoverPolicy: Failover policy of the read-only endpoint for the failover group.

    FailoverGroupReadOnlyEndpoint_FailoverPolicy (string alias)

    (Appears on:FailoverGroupReadOnlyEndpoint)

    Value Description

    "Disabled"

    "Enabled"

    FailoverGroupReadOnlyEndpoint_FailoverPolicy_ARM (string alias)

    (Appears on:FailoverGroupReadOnlyEndpoint_ARM)

    Value Description

    "Disabled"

    "Enabled"

    FailoverGroupReadOnlyEndpoint_FailoverPolicy_STATUS (string alias)

    (Appears on:FailoverGroupReadOnlyEndpoint_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    FailoverGroupReadOnlyEndpoint_FailoverPolicy_STATUS_ARM (string alias)

    (Appears on:FailoverGroupReadOnlyEndpoint_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    FailoverGroupReadOnlyEndpoint_STATUS

    (Appears on:Servers_FailoverGroup_STATUS)

    Read-only endpoint of the failover group instance.

    Field Description
    failoverPolicy
    FailoverGroupReadOnlyEndpoint_FailoverPolicy_STATUS

    FailoverPolicy: Failover policy of the read-only endpoint for the failover group.

    FailoverGroupReadOnlyEndpoint_STATUS_ARM

    (Appears on:FailoverGroupProperties_STATUS_ARM)

    Read-only endpoint of the failover group instance.

    Field Description
    failoverPolicy
    FailoverGroupReadOnlyEndpoint_FailoverPolicy_STATUS_ARM

    FailoverPolicy: Failover policy of the read-only endpoint for the failover group.

    FailoverGroupReadWriteEndpoint

    (Appears on:Servers_FailoverGroup_Spec)

    Read-write endpoint of the failover group instance.

    Field Description
    failoverPolicy
    FailoverGroupReadWriteEndpoint_FailoverPolicy

    FailoverPolicy: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

    failoverWithDataLossGracePeriodMinutes
    int

    FailoverWithDataLossGracePeriodMinutes: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

    FailoverGroupReadWriteEndpoint_ARM

    (Appears on:FailoverGroupProperties_ARM)

    Read-write endpoint of the failover group instance.

    Field Description
    failoverPolicy
    FailoverGroupReadWriteEndpoint_FailoverPolicy_ARM

    FailoverPolicy: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

    failoverWithDataLossGracePeriodMinutes
    int

    FailoverWithDataLossGracePeriodMinutes: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

    FailoverGroupReadWriteEndpoint_FailoverPolicy (string alias)

    (Appears on:FailoverGroupReadWriteEndpoint)

    Value Description

    "Automatic"

    "Manual"

    FailoverGroupReadWriteEndpoint_FailoverPolicy_ARM (string alias)

    (Appears on:FailoverGroupReadWriteEndpoint_ARM)

    Value Description

    "Automatic"

    "Manual"

    FailoverGroupReadWriteEndpoint_FailoverPolicy_STATUS (string alias)

    (Appears on:FailoverGroupReadWriteEndpoint_STATUS)

    Value Description

    "Automatic"

    "Manual"

    FailoverGroupReadWriteEndpoint_FailoverPolicy_STATUS_ARM (string alias)

    (Appears on:FailoverGroupReadWriteEndpoint_STATUS_ARM)

    Value Description

    "Automatic"

    "Manual"

    FailoverGroupReadWriteEndpoint_STATUS

    (Appears on:Servers_FailoverGroup_STATUS)

    Read-write endpoint of the failover group instance.

    Field Description
    failoverPolicy
    FailoverGroupReadWriteEndpoint_FailoverPolicy_STATUS

    FailoverPolicy: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

    failoverWithDataLossGracePeriodMinutes
    int

    FailoverWithDataLossGracePeriodMinutes: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

    FailoverGroupReadWriteEndpoint_STATUS_ARM

    (Appears on:FailoverGroupProperties_STATUS_ARM)

    Read-write endpoint of the failover group instance.

    Field Description
    failoverPolicy
    FailoverGroupReadWriteEndpoint_FailoverPolicy_STATUS_ARM

    FailoverPolicy: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

    failoverWithDataLossGracePeriodMinutes
    int

    FailoverWithDataLossGracePeriodMinutes: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

    IPv6ServerFirewallRuleProperties_ARM

    (Appears on:Servers_Ipv6FirewallRule_Spec_ARM)

    The properties of an IPv6 server firewall rule.

    Field Description
    endIPv6Address
    string

    EndIPv6Address: The end IP address of the firewall rule. Must be IPv6 format. Must be greater than or equal to startIpAddress.

    startIPv6Address
    string

    StartIPv6Address: The start IP address of the firewall rule. Must be IPv6 format.

    IPv6ServerFirewallRuleProperties_STATUS_ARM

    (Appears on:Servers_Ipv6FirewallRule_STATUS_ARM)

    The properties of an IPv6 server firewall rule.

    Field Description
    endIPv6Address
    string

    EndIPv6Address: The end IP address of the firewall rule. Must be IPv6 format. Must be greater than or equal to startIpAddress.

    startIPv6Address
    string

    StartIPv6Address: The start IP address of the firewall rule. Must be IPv6 format.

    OutboundFirewallRuleProperties_STATUS_ARM

    (Appears on:Servers_OutboundFirewallRule_STATUS_ARM)

    The properties of an outbound firewall rule.

    Field Description
    provisioningState
    string

    ProvisioningState: The state of the outbound rule.

    PartnerInfo

    (Appears on:Servers_FailoverGroup_Spec)

    Partner server information for the failover group.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource identifier of the partner server.

    PartnerInfo_ARM

    (Appears on:FailoverGroupProperties_ARM)

    Partner server information for the failover group.

    Field Description
    id
    string

    PartnerInfo_ReplicationRole_STATUS (string alias)

    (Appears on:PartnerInfo_STATUS)

    Value Description

    "Primary"

    "Secondary"

    PartnerInfo_ReplicationRole_STATUS_ARM (string alias)

    (Appears on:PartnerInfo_STATUS_ARM)

    Value Description

    "Primary"

    "Secondary"

    PartnerInfo_STATUS

    (Appears on:Servers_FailoverGroup_STATUS)

    Partner server information for the failover group.

    Field Description
    id
    string

    Id: Resource identifier of the partner server.

    location
    string

    Location: Geo location of the partner server.

    replicationRole
    PartnerInfo_ReplicationRole_STATUS

    ReplicationRole: Replication role of the partner server.

    PartnerInfo_STATUS_ARM

    (Appears on:FailoverGroupProperties_STATUS_ARM)

    Partner server information for the failover group.

    Field Description
    id
    string

    Id: Resource identifier of the partner server.

    location
    string

    Location: Geo location of the partner server.

    replicationRole
    PartnerInfo_ReplicationRole_STATUS_ARM

    ReplicationRole: Replication role of the partner server.

    PrivateEndpointConnectionProperties_ProvisioningState_STATUS (string alias)

    (Appears on:PrivateEndpointConnectionProperties_STATUS)

    Value Description

    "Approving"

    "Dropping"

    "Failed"

    "Ready"

    "Rejecting"

    PrivateEndpointConnectionProperties_ProvisioningState_STATUS_ARM (string alias)

    (Appears on:PrivateEndpointConnectionProperties_STATUS_ARM)

    Value Description

    "Approving"

    "Dropping"

    "Failed"

    "Ready"

    "Rejecting"

    PrivateEndpointConnectionProperties_STATUS

    (Appears on:ServerPrivateEndpointConnection_STATUS)

    Properties of a private endpoint connection.

    Field Description
    groupIds
    []string

    GroupIds: Group IDs.

    privateEndpoint
    PrivateEndpointProperty_STATUS

    PrivateEndpoint: Private endpoint which the connection belongs to.

    privateLinkServiceConnectionState
    PrivateLinkServiceConnectionStateProperty_STATUS

    PrivateLinkServiceConnectionState: Connection state of the private endpoint connection.

    provisioningState
    PrivateEndpointConnectionProperties_ProvisioningState_STATUS

    ProvisioningState: State of the private endpoint connection.

    PrivateEndpointConnectionProperties_STATUS_ARM

    (Appears on:ServerPrivateEndpointConnection_STATUS_ARM)

    Properties of a private endpoint connection.

    Field Description
    groupIds
    []string

    GroupIds: Group IDs.

    privateEndpoint
    PrivateEndpointProperty_STATUS_ARM

    PrivateEndpoint: Private endpoint which the connection belongs to.

    privateLinkServiceConnectionState
    PrivateLinkServiceConnectionStateProperty_STATUS_ARM

    PrivateLinkServiceConnectionState: Connection state of the private endpoint connection.

    provisioningState
    PrivateEndpointConnectionProperties_ProvisioningState_STATUS_ARM

    ProvisioningState: State of the private endpoint connection.

    PrivateEndpointProperty_STATUS

    (Appears on:PrivateEndpointConnectionProperties_STATUS)

    Field Description
    id
    string

    Id: Resource id of the private endpoint.

    PrivateEndpointProperty_STATUS_ARM

    (Appears on:PrivateEndpointConnectionProperties_STATUS_ARM)

    Field Description
    id
    string

    Id: Resource id of the private endpoint.

    PrivateLinkServiceConnectionStateProperty_ActionsRequired_STATUS (string alias)

    (Appears on:PrivateLinkServiceConnectionStateProperty_STATUS)

    Value Description

    "None"

    PrivateLinkServiceConnectionStateProperty_ActionsRequired_STATUS_ARM (string alias)

    (Appears on:PrivateLinkServiceConnectionStateProperty_STATUS_ARM)

    Value Description

    "None"

    PrivateLinkServiceConnectionStateProperty_STATUS

    (Appears on:PrivateEndpointConnectionProperties_STATUS)

    Field Description
    actionsRequired
    PrivateLinkServiceConnectionStateProperty_ActionsRequired_STATUS

    ActionsRequired: The actions required for private link service connection.

    description
    string

    Description: The private link service connection description.

    status
    PrivateLinkServiceConnectionStateProperty_Status_STATUS

    Status: The private link service connection status.

    PrivateLinkServiceConnectionStateProperty_STATUS_ARM

    (Appears on:PrivateEndpointConnectionProperties_STATUS_ARM)

    Field Description
    actionsRequired
    PrivateLinkServiceConnectionStateProperty_ActionsRequired_STATUS_ARM

    ActionsRequired: The actions required for private link service connection.

    description
    string

    Description: The private link service connection description.

    status
    PrivateLinkServiceConnectionStateProperty_Status_STATUS_ARM

    Status: The private link service connection status.

    PrivateLinkServiceConnectionStateProperty_Status_STATUS (string alias)

    (Appears on:PrivateLinkServiceConnectionStateProperty_STATUS)

    Value Description

    "Approved"

    "Disconnected"

    "Pending"

    "Rejected"

    PrivateLinkServiceConnectionStateProperty_Status_STATUS_ARM (string alias)

    (Appears on:PrivateLinkServiceConnectionStateProperty_STATUS_ARM)

    Value Description

    "Approved"

    "Disconnected"

    "Pending"

    "Rejected"

    ResourceIdentity

    (Appears on:Server_Spec)

    Azure Active Directory identity configuration for a resource.

    Field Description
    type
    ResourceIdentity_Type

    Type: The identity type. Set this to ‘SystemAssigned’ in order to automatically create and assign an Azure Active Directory principal for the resource.

    userAssignedIdentities
    []UserAssignedIdentityDetails

    UserAssignedIdentities: The resource ids of the user assigned identities to use

    ResourceIdentity_ARM

    (Appears on:Server_Spec_ARM)

    Azure Active Directory identity configuration for a resource.

    Field Description
    type
    ResourceIdentity_Type_ARM

    Type: The identity type. Set this to ‘SystemAssigned’ in order to automatically create and assign an Azure Active Directory principal for the resource.

    userAssignedIdentities
    map[string]./api/sql/v1api20211101.UserAssignedIdentityDetails_ARM

    ResourceIdentity_STATUS

    (Appears on:Server_STATUS)

    Azure Active Directory identity configuration for a resource.

    Field Description
    principalId
    string

    PrincipalId: The Azure Active Directory principal id.

    tenantId
    string

    TenantId: The Azure Active Directory tenant id.

    type
    ResourceIdentity_Type_STATUS

    Type: The identity type. Set this to ‘SystemAssigned’ in order to automatically create and assign an Azure Active Directory principal for the resource.

    userAssignedIdentities
    map[string]./api/sql/v1api20211101.UserIdentity_STATUS

    UserAssignedIdentities: The resource ids of the user assigned identities to use

    ResourceIdentity_STATUS_ARM

    (Appears on:Server_STATUS_ARM)

    Azure Active Directory identity configuration for a resource.

    Field Description
    principalId
    string

    PrincipalId: The Azure Active Directory principal id.

    tenantId
    string

    TenantId: The Azure Active Directory tenant id.

    type
    ResourceIdentity_Type_STATUS_ARM

    Type: The identity type. Set this to ‘SystemAssigned’ in order to automatically create and assign an Azure Active Directory principal for the resource.

    userAssignedIdentities
    map[string]./api/sql/v1api20211101.UserIdentity_STATUS_ARM

    UserAssignedIdentities: The resource ids of the user assigned identities to use

    ResourceIdentity_Type (string alias)

    (Appears on:ResourceIdentity)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned,UserAssigned"

    "UserAssigned"

    ResourceIdentity_Type_ARM (string alias)

    (Appears on:ResourceIdentity_ARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned,UserAssigned"

    "UserAssigned"

    ResourceIdentity_Type_STATUS (string alias)

    (Appears on:ResourceIdentity_STATUS)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned,UserAssigned"

    "UserAssigned"

    ResourceIdentity_Type_STATUS_ARM (string alias)

    (Appears on:ResourceIdentity_STATUS_ARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned,UserAssigned"

    "UserAssigned"

    Server

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/Servers.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Server_Spec


    administratorLogin
    string

    AdministratorLogin: Administrator username for the server. Once created it cannot be changed.

    administratorLoginPassword
    genruntime.SecretReference

    AdministratorLoginPassword: The administrator login password (required for server creation).

    administrators
    ServerExternalAdministrator

    Administrators: The Azure Active Directory administrator of the server.

    azureName
    string

    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.

    federatedClientId
    string

    FederatedClientId: The Client id used for cross tenant CMK scenario

    identity
    ResourceIdentity

    Identity: The Azure Active Directory identity of the server.

    keyId
    string

    KeyId: A CMK URI of the key to use for encryption.

    location
    string

    Location: Resource location.

    minimalTlsVersion
    string

    MinimalTlsVersion: Minimal TLS version. Allowed values: ‘1.0’, ‘1.1’, ‘1.2’

    operatorSpec
    ServerOperatorSpec

    OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure

    owner
    genruntime.KnownResourceReference

    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

    primaryUserAssignedIdentityReference
    genruntime.ResourceReference

    PrimaryUserAssignedIdentityReference: The resource id of a user assigned identity to be used by default.

    publicNetworkAccess
    ServerProperties_PublicNetworkAccess

    PublicNetworkAccess: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’

    restrictOutboundNetworkAccess
    ServerProperties_RestrictOutboundNetworkAccess

    RestrictOutboundNetworkAccess: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’

    tags
    map[string]string

    Tags: Resource tags.

    version
    string

    Version: The version of the server.

    status
    Server_STATUS

    ServerBlobAuditingPolicyProperties_ARM

    (Appears on:Servers_AuditingSetting_Spec_ARM)

    Properties of a server blob auditing policy.

    Field Description
    auditActionsAndGroups
    []string

    AuditActionsAndGroups: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see Database-Level Audit Action Groups. For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see Database-Level Audit Actions

    isAzureMonitorTargetEnabled
    bool

    IsAzureMonitorTargetEnabled: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘State’ as ‘Enabled’ and ‘IsAzureMonitorTargetEnabled’ as true. When using REST API to configure auditing, Diagnostic Settings with ‘SQLSecurityAuditEvents’ diagnostic logs category on the database should be also created. Note that for server level audit you should use the ‘master’ database as {databaseName}. Diagnostic Settings URI format: PUT https:/​/​management.azure.com/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroup}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​{databaseName}/​providers/​microsoft.insights/​diagnosticSettings/​{settingsName}?api-version=2017-05-01-preview For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

    isDevopsAuditEnabled
    bool

    IsDevopsAuditEnabled: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘State’ as ‘Enabled’, ‘IsAzureMonitorTargetEnabled’ as true and ‘IsDevopsAuditEnabled’ as true When using REST API to configure auditing, Diagnostic Settings with ‘DevOpsOperationsAudit’ diagnostic logs category on the master database should also be created. Diagnostic Settings URI format: PUT https:/​/​management.azure.com/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroup}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​master/​providers/​microsoft.insights/​diagnosticSettings/​{settingsName}?api-version=2017-05-01-preview For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

    isManagedIdentityInUse
    bool

    IsManagedIdentityInUse: Specifies whether Managed Identity is used to access blob storage

    isStorageSecondaryKeyInUse
    bool

    IsStorageSecondaryKeyInUse: Specifies whether storageAccountAccessKey value is the storage’s secondary key.

    queueDelayMs
    int

    QueueDelayMs: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.

    retentionDays
    int

    RetentionDays: Specifies the number of days to keep in the audit logs in the storage account.

    state
    ServerBlobAuditingPolicyProperties_State_ARM

    State: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.

    storageAccountAccessKey
    string

    StorageAccountAccessKey: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding ‘Storage Blob Data Contributor’ RBAC role to the server identity. For more information, see Auditing to storage using Managed Identity authentication

    storageAccountSubscriptionId
    string

    StorageAccountSubscriptionId: Specifies the blob storage subscription Id.

    storageEndpoint
    string

    StorageEndpoint: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.

    ServerBlobAuditingPolicyProperties_STATUS_ARM

    (Appears on:Servers_AuditingSetting_STATUS_ARM)

    Properties of a server blob auditing policy.

    Field Description
    auditActionsAndGroups
    []string

    AuditActionsAndGroups: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see Database-Level Audit Action Groups. For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see Database-Level Audit Actions

    isAzureMonitorTargetEnabled
    bool

    IsAzureMonitorTargetEnabled: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘State’ as ‘Enabled’ and ‘IsAzureMonitorTargetEnabled’ as true. When using REST API to configure auditing, Diagnostic Settings with ‘SQLSecurityAuditEvents’ diagnostic logs category on the database should be also created. Note that for server level audit you should use the ‘master’ database as {databaseName}. Diagnostic Settings URI format: PUT https:/​/​management.azure.com/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroup}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​{databaseName}/​providers/​microsoft.insights/​diagnosticSettings/​{settingsName}?api-version=2017-05-01-preview For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

    isDevopsAuditEnabled
    bool

    IsDevopsAuditEnabled: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘State’ as ‘Enabled’, ‘IsAzureMonitorTargetEnabled’ as true and ‘IsDevopsAuditEnabled’ as true When using REST API to configure auditing, Diagnostic Settings with ‘DevOpsOperationsAudit’ diagnostic logs category on the master database should also be created. Diagnostic Settings URI format: PUT https:/​/​management.azure.com/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroup}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​master/​providers/​microsoft.insights/​diagnosticSettings/​{settingsName}?api-version=2017-05-01-preview For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

    isManagedIdentityInUse
    bool

    IsManagedIdentityInUse: Specifies whether Managed Identity is used to access blob storage

    isStorageSecondaryKeyInUse
    bool

    IsStorageSecondaryKeyInUse: Specifies whether storageAccountAccessKey value is the storage’s secondary key.

    queueDelayMs
    int

    QueueDelayMs: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.

    retentionDays
    int

    RetentionDays: Specifies the number of days to keep in the audit logs in the storage account.

    state
    ServerBlobAuditingPolicyProperties_State_STATUS_ARM

    State: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.

    storageAccountSubscriptionId
    string

    StorageAccountSubscriptionId: Specifies the blob storage subscription Id.

    storageEndpoint
    string

    StorageEndpoint: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.

    ServerBlobAuditingPolicyProperties_State (string alias)

    (Appears on:Servers_AuditingSetting_Spec)

    Value Description

    "Disabled"

    "Enabled"

    ServerBlobAuditingPolicyProperties_State_ARM (string alias)

    (Appears on:ServerBlobAuditingPolicyProperties_ARM)

    Value Description

    "Disabled"

    "Enabled"

    ServerBlobAuditingPolicyProperties_State_STATUS (string alias)

    (Appears on:Servers_AuditingSetting_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    ServerBlobAuditingPolicyProperties_State_STATUS_ARM (string alias)

    (Appears on:ServerBlobAuditingPolicyProperties_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    ServerConnectionPolicyProperties_ARM

    (Appears on:Servers_ConnectionPolicy_Spec_ARM)

    The properties of a server connection policy.

    Field Description
    connectionType
    ServerConnectionPolicyProperties_ConnectionType_ARM

    ConnectionType: The server connection type.

    ServerConnectionPolicyProperties_ConnectionType (string alias)

    (Appears on:Servers_ConnectionPolicy_Spec)

    Value Description

    "Default"

    "Proxy"

    "Redirect"

    ServerConnectionPolicyProperties_ConnectionType_ARM (string alias)

    (Appears on:ServerConnectionPolicyProperties_ARM)

    Value Description

    "Default"

    "Proxy"

    "Redirect"

    ServerConnectionPolicyProperties_ConnectionType_STATUS (string alias)

    (Appears on:Servers_ConnectionPolicy_STATUS)

    Value Description

    "Default"

    "Proxy"

    "Redirect"

    ServerConnectionPolicyProperties_ConnectionType_STATUS_ARM (string alias)

    (Appears on:ServerConnectionPolicyProperties_STATUS_ARM)

    Value Description

    "Default"

    "Proxy"

    "Redirect"

    ServerConnectionPolicyProperties_STATUS_ARM

    (Appears on:Servers_ConnectionPolicy_STATUS_ARM)

    The properties of a server connection policy.

    Field Description
    connectionType
    ServerConnectionPolicyProperties_ConnectionType_STATUS_ARM

    ConnectionType: The server connection type.

    ServerExternalAdministrator

    (Appears on:Server_Spec)

    Properties of a active directory administrator.

    Field Description
    administratorType
    ServerExternalAdministrator_AdministratorType

    AdministratorType: Type of the sever administrator.

    azureADOnlyAuthentication
    bool

    AzureADOnlyAuthentication: Azure Active Directory only Authentication enabled.

    login
    string

    Login: Login name of the server administrator.

    principalType
    ServerExternalAdministrator_PrincipalType

    PrincipalType: Principal Type of the sever administrator.

    sid
    string

    Sid: SID (object ID) of the server administrator.

    tenantId
    string

    TenantId: Tenant ID of the administrator.

    ServerExternalAdministrator_ARM

    (Appears on:ServerProperties_ARM)

    Properties of a active directory administrator.

    Field Description
    administratorType
    ServerExternalAdministrator_AdministratorType_ARM

    AdministratorType: Type of the sever administrator.

    azureADOnlyAuthentication
    bool

    AzureADOnlyAuthentication: Azure Active Directory only Authentication enabled.

    login
    string

    Login: Login name of the server administrator.

    principalType
    ServerExternalAdministrator_PrincipalType_ARM

    PrincipalType: Principal Type of the sever administrator.

    sid
    string

    Sid: SID (object ID) of the server administrator.

    tenantId
    string

    TenantId: Tenant ID of the administrator.

    ServerExternalAdministrator_AdministratorType (string alias)

    (Appears on:ServerExternalAdministrator)

    Value Description

    "ActiveDirectory"

    ServerExternalAdministrator_AdministratorType_ARM (string alias)

    (Appears on:ServerExternalAdministrator_ARM)

    Value Description

    "ActiveDirectory"

    ServerExternalAdministrator_AdministratorType_STATUS (string alias)

    (Appears on:ServerExternalAdministrator_STATUS)

    Value Description

    "ActiveDirectory"

    ServerExternalAdministrator_AdministratorType_STATUS_ARM (string alias)

    (Appears on:ServerExternalAdministrator_STATUS_ARM)

    Value Description

    "ActiveDirectory"

    ServerExternalAdministrator_PrincipalType (string alias)

    (Appears on:ServerExternalAdministrator)

    Value Description

    "Application"

    "Group"

    "User"

    ServerExternalAdministrator_PrincipalType_ARM (string alias)

    (Appears on:ServerExternalAdministrator_ARM)

    Value Description

    "Application"

    "Group"

    "User"

    ServerExternalAdministrator_PrincipalType_STATUS (string alias)

    (Appears on:ServerExternalAdministrator_STATUS)

    Value Description

    "Application"

    "Group"

    "User"

    ServerExternalAdministrator_PrincipalType_STATUS_ARM (string alias)

    (Appears on:ServerExternalAdministrator_STATUS_ARM)

    Value Description

    "Application"

    "Group"

    "User"

    ServerExternalAdministrator_STATUS

    (Appears on:Server_STATUS)

    Properties of a active directory administrator.

    Field Description
    administratorType
    ServerExternalAdministrator_AdministratorType_STATUS

    AdministratorType: Type of the sever administrator.

    azureADOnlyAuthentication
    bool

    AzureADOnlyAuthentication: Azure Active Directory only Authentication enabled.

    login
    string

    Login: Login name of the server administrator.

    principalType
    ServerExternalAdministrator_PrincipalType_STATUS

    PrincipalType: Principal Type of the sever administrator.

    sid
    string

    Sid: SID (object ID) of the server administrator.

    tenantId
    string

    TenantId: Tenant ID of the administrator.

    ServerExternalAdministrator_STATUS_ARM

    (Appears on:ServerProperties_STATUS_ARM)

    Properties of a active directory administrator.

    Field Description
    administratorType
    ServerExternalAdministrator_AdministratorType_STATUS_ARM

    AdministratorType: Type of the sever administrator.

    azureADOnlyAuthentication
    bool

    AzureADOnlyAuthentication: Azure Active Directory only Authentication enabled.

    login
    string

    Login: Login name of the server administrator.

    principalType
    ServerExternalAdministrator_PrincipalType_STATUS_ARM

    PrincipalType: Principal Type of the sever administrator.

    sid
    string

    Sid: SID (object ID) of the server administrator.

    tenantId
    string

    TenantId: Tenant ID of the administrator.

    ServerFirewallRuleProperties_ARM

    (Appears on:Servers_FirewallRule_Spec_ARM)

    The properties of a server firewall rule.

    Field Description
    endIpAddress
    string

    EndIpAddress: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value ‘0.0.0.0’ for all Azure-internal IP addresses.

    startIpAddress
    string

    StartIpAddress: The start IP address of the firewall rule. Must be IPv4 format. Use value ‘0.0.0.0’ for all Azure-internal IP addresses.

    ServerFirewallRuleProperties_STATUS_ARM

    (Appears on:Servers_FirewallRule_STATUS_ARM)

    The properties of a server firewall rule.

    Field Description
    endIpAddress
    string

    EndIpAddress: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value ‘0.0.0.0’ for all Azure-internal IP addresses.

    startIpAddress
    string

    StartIpAddress: The start IP address of the firewall rule. Must be IPv4 format. Use value ‘0.0.0.0’ for all Azure-internal IP addresses.

    ServerOperatorConfigMaps

    (Appears on:ServerOperatorSpec)

    Field Description
    fullyQualifiedDomainName
    genruntime.ConfigMapDestination

    FullyQualifiedDomainName: indicates where the FullyQualifiedDomainName config map should be placed. If omitted, no config map will be created.

    ServerOperatorSpec

    (Appears on:Server_Spec)

    Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

    Field Description
    configMaps
    ServerOperatorConfigMaps

    ConfigMaps: configures where to place operator written ConfigMaps.

    ServerPrivateEndpointConnection_STATUS

    (Appears on:Server_STATUS)

    A private endpoint connection under a server

    Field Description
    id
    string

    Id: Resource ID.

    properties
    PrivateEndpointConnectionProperties_STATUS

    Properties: Private endpoint connection properties

    ServerPrivateEndpointConnection_STATUS_ARM

    (Appears on:ServerProperties_STATUS_ARM)

    A private endpoint connection under a server

    Field Description
    id
    string

    Id: Resource ID.

    properties
    PrivateEndpointConnectionProperties_STATUS_ARM

    Properties: Private endpoint connection properties

    ServerProperties_ARM

    (Appears on:Server_Spec_ARM)

    The properties of a server.

    Field Description
    administratorLogin
    string

    AdministratorLogin: Administrator username for the server. Once created it cannot be changed.

    administratorLoginPassword
    string

    AdministratorLoginPassword: The administrator login password (required for server creation).

    administrators
    ServerExternalAdministrator_ARM

    Administrators: The Azure Active Directory administrator of the server.

    federatedClientId
    string

    FederatedClientId: The Client id used for cross tenant CMK scenario

    keyId
    string

    KeyId: A CMK URI of the key to use for encryption.

    minimalTlsVersion
    string

    MinimalTlsVersion: Minimal TLS version. Allowed values: ‘1.0’, ‘1.1’, ‘1.2’

    primaryUserAssignedIdentityId
    string
    publicNetworkAccess
    ServerProperties_PublicNetworkAccess_ARM

    PublicNetworkAccess: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’

    restrictOutboundNetworkAccess
    ServerProperties_RestrictOutboundNetworkAccess_ARM

    RestrictOutboundNetworkAccess: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’

    version
    string

    Version: The version of the server.

    ServerProperties_PublicNetworkAccess (string alias)

    (Appears on:Server_Spec)

    Value Description

    "Disabled"

    "Enabled"

    ServerProperties_PublicNetworkAccess_ARM (string alias)

    (Appears on:ServerProperties_ARM)

    Value Description

    "Disabled"

    "Enabled"

    ServerProperties_PublicNetworkAccess_STATUS (string alias)

    (Appears on:Server_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    ServerProperties_PublicNetworkAccess_STATUS_ARM (string alias)

    (Appears on:ServerProperties_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    ServerProperties_RestrictOutboundNetworkAccess (string alias)

    (Appears on:Server_Spec)

    Value Description

    "Disabled"

    "Enabled"

    ServerProperties_RestrictOutboundNetworkAccess_ARM (string alias)

    (Appears on:ServerProperties_ARM)

    Value Description

    "Disabled"

    "Enabled"

    ServerProperties_RestrictOutboundNetworkAccess_STATUS (string alias)

    (Appears on:Server_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    ServerProperties_RestrictOutboundNetworkAccess_STATUS_ARM (string alias)

    (Appears on:ServerProperties_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    ServerProperties_STATUS_ARM

    (Appears on:Server_STATUS_ARM)

    The properties of a server.

    Field Description
    administratorLogin
    string

    AdministratorLogin: Administrator username for the server. Once created it cannot be changed.

    administrators
    ServerExternalAdministrator_STATUS_ARM

    Administrators: The Azure Active Directory administrator of the server.

    federatedClientId
    string

    FederatedClientId: The Client id used for cross tenant CMK scenario

    fullyQualifiedDomainName
    string

    FullyQualifiedDomainName: The fully qualified domain name of the server.

    keyId
    string

    KeyId: A CMK URI of the key to use for encryption.

    minimalTlsVersion
    string

    MinimalTlsVersion: Minimal TLS version. Allowed values: ‘1.0’, ‘1.1’, ‘1.2’

    primaryUserAssignedIdentityId
    string

    PrimaryUserAssignedIdentityId: The resource id of a user assigned identity to be used by default.

    privateEndpointConnections
    []ServerPrivateEndpointConnection_STATUS_ARM

    PrivateEndpointConnections: List of private endpoint connections on a server

    publicNetworkAccess
    ServerProperties_PublicNetworkAccess_STATUS_ARM

    PublicNetworkAccess: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’

    restrictOutboundNetworkAccess
    ServerProperties_RestrictOutboundNetworkAccess_STATUS_ARM

    RestrictOutboundNetworkAccess: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’

    state
    string

    State: The state of the server.

    version
    string

    Version: The version of the server.

    workspaceFeature
    ServerProperties_WorkspaceFeature_STATUS_ARM

    WorkspaceFeature: Whether or not existing server has a workspace created and if it allows connection from workspace

    ServerProperties_WorkspaceFeature_STATUS (string alias)

    (Appears on:Server_STATUS)

    Value Description

    "Connected"

    "Disconnected"

    ServerProperties_WorkspaceFeature_STATUS_ARM (string alias)

    (Appears on:ServerProperties_STATUS_ARM)

    Value Description

    "Connected"

    "Disconnected"

    ServerSecurityAlertPoliciesSecurityAlertsPolicyProperties_ARM

    (Appears on:Servers_SecurityAlertPolicy_Spec_ARM)

    Properties of a security alert policy.

    Field Description
    disabledAlerts
    []string

    DisabledAlerts: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force

    emailAccountAdmins
    bool

    EmailAccountAdmins: Specifies that the alert is sent to the account administrators.

    emailAddresses
    []string

    EmailAddresses: Specifies an array of e-mail addresses to which the alert is sent.

    retentionDays
    int

    RetentionDays: Specifies the number of days to keep in the Threat Detection audit logs.

    state
    ServerSecurityAlertPoliciesSecurityAlertsPolicyProperties_State_ARM

    State: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.

    storageAccountAccessKey
    string

    StorageAccountAccessKey: Specifies the identifier key of the Threat Detection audit storage account.

    storageEndpoint
    string

    StorageEndpoint: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

    ServerSecurityAlertPoliciesSecurityAlertsPolicyProperties_STATUS_ARM

    (Appears on:Servers_SecurityAlertPolicy_STATUS_ARM)

    Properties of a security alert policy.

    Field Description
    creationTime
    string

    CreationTime: Specifies the UTC creation time of the policy.

    disabledAlerts
    []string

    DisabledAlerts: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force

    emailAccountAdmins
    bool

    EmailAccountAdmins: Specifies that the alert is sent to the account administrators.

    emailAddresses
    []string

    EmailAddresses: Specifies an array of e-mail addresses to which the alert is sent.

    retentionDays
    int

    RetentionDays: Specifies the number of days to keep in the Threat Detection audit logs.

    state
    ServerSecurityAlertPoliciesSecurityAlertsPolicyProperties_State_STATUS_ARM

    State: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.

    storageEndpoint
    string

    StorageEndpoint: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

    ServerSecurityAlertPoliciesSecurityAlertsPolicyProperties_State (string alias)

    (Appears on:Servers_SecurityAlertPolicy_Spec)

    Value Description

    "Disabled"

    "Enabled"

    ServerSecurityAlertPoliciesSecurityAlertsPolicyProperties_State_ARM (string alias)

    (Appears on:ServerSecurityAlertPoliciesSecurityAlertsPolicyProperties_ARM)

    Value Description

    "Disabled"

    "Enabled"

    ServerSecurityAlertPoliciesSecurityAlertsPolicyProperties_State_STATUS (string alias)

    (Appears on:Servers_SecurityAlertPolicy_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    ServerSecurityAlertPoliciesSecurityAlertsPolicyProperties_State_STATUS_ARM (string alias)

    (Appears on:ServerSecurityAlertPoliciesSecurityAlertsPolicyProperties_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    ServerVulnerabilityAssessmentProperties_ARM

    (Appears on:Servers_VulnerabilityAssessment_Spec_ARM)

    Properties of a server Vulnerability Assessment.

    Field Description
    recurringScans
    VulnerabilityAssessmentRecurringScansProperties_ARM

    RecurringScans: The recurring scans settings

    storageAccountAccessKey
    string

    StorageAccountAccessKey: Specifies the identifier key of the storage account for vulnerability assessment scan results. If ‘StorageContainerSasKey’ isn’t specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall

    storageContainerPath
    string

    StorageContainerPath: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).

    storageContainerSasKey
    string

    StorageContainerSasKey: A shared access signature (SAS Key) that has write access to the blob container specified in ‘storageContainerPath’ parameter. If ‘storageAccountAccessKey’ isn’t specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall

    ServerVulnerabilityAssessmentProperties_STATUS_ARM

    (Appears on:Servers_VulnerabilityAssessment_STATUS_ARM)

    Properties of a server Vulnerability Assessment.

    Field Description
    recurringScans
    VulnerabilityAssessmentRecurringScansProperties_STATUS_ARM

    RecurringScans: The recurring scans settings

    storageContainerPath
    string

    StorageContainerPath: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).

    Server_STATUS

    (Appears on:Server)

    An Azure SQL Database server.

    Field Description
    administratorLogin
    string

    AdministratorLogin: Administrator username for the server. Once created it cannot be changed.

    administrators
    ServerExternalAdministrator_STATUS

    Administrators: The Azure Active Directory administrator of the server.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    federatedClientId
    string

    FederatedClientId: The Client id used for cross tenant CMK scenario

    fullyQualifiedDomainName
    string

    FullyQualifiedDomainName: The fully qualified domain name of the server.

    id
    string

    Id: Resource ID.

    identity
    ResourceIdentity_STATUS

    Identity: The Azure Active Directory identity of the server.

    keyId
    string

    KeyId: A CMK URI of the key to use for encryption.

    kind
    string

    Kind: Kind of sql server. This is metadata used for the Azure portal experience.

    location
    string

    Location: Resource location.

    minimalTlsVersion
    string

    MinimalTlsVersion: Minimal TLS version. Allowed values: ‘1.0’, ‘1.1’, ‘1.2’

    name
    string

    Name: Resource name.

    primaryUserAssignedIdentityId
    string

    PrimaryUserAssignedIdentityId: The resource id of a user assigned identity to be used by default.

    privateEndpointConnections
    []ServerPrivateEndpointConnection_STATUS

    PrivateEndpointConnections: List of private endpoint connections on a server

    publicNetworkAccess
    ServerProperties_PublicNetworkAccess_STATUS

    PublicNetworkAccess: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’

    restrictOutboundNetworkAccess
    ServerProperties_RestrictOutboundNetworkAccess_STATUS

    RestrictOutboundNetworkAccess: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’

    state
    string

    State: The state of the server.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    version
    string

    Version: The version of the server.

    workspaceFeature
    ServerProperties_WorkspaceFeature_STATUS

    WorkspaceFeature: Whether or not existing server has a workspace created and if it allows connection from workspace

    Server_STATUS_ARM

    An Azure SQL Database server.

    Field Description
    id
    string

    Id: Resource ID.

    identity
    ResourceIdentity_STATUS_ARM

    Identity: The Azure Active Directory identity of the server.

    kind
    string

    Kind: Kind of sql server. This is metadata used for the Azure portal experience.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    properties
    ServerProperties_STATUS_ARM

    Properties: Resource properties.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    Server_Spec

    (Appears on:Server)

    Field Description
    administratorLogin
    string

    AdministratorLogin: Administrator username for the server. Once created it cannot be changed.

    administratorLoginPassword
    genruntime.SecretReference

    AdministratorLoginPassword: The administrator login password (required for server creation).

    administrators
    ServerExternalAdministrator

    Administrators: The Azure Active Directory administrator of the server.

    azureName
    string

    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.

    federatedClientId
    string

    FederatedClientId: The Client id used for cross tenant CMK scenario

    identity
    ResourceIdentity

    Identity: The Azure Active Directory identity of the server.

    keyId
    string

    KeyId: A CMK URI of the key to use for encryption.

    location
    string

    Location: Resource location.

    minimalTlsVersion
    string

    MinimalTlsVersion: Minimal TLS version. Allowed values: ‘1.0’, ‘1.1’, ‘1.2’

    operatorSpec
    ServerOperatorSpec

    OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure

    owner
    genruntime.KnownResourceReference

    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

    primaryUserAssignedIdentityReference
    genruntime.ResourceReference

    PrimaryUserAssignedIdentityReference: The resource id of a user assigned identity to be used by default.

    publicNetworkAccess
    ServerProperties_PublicNetworkAccess

    PublicNetworkAccess: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’

    restrictOutboundNetworkAccess
    ServerProperties_RestrictOutboundNetworkAccess

    RestrictOutboundNetworkAccess: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’

    tags
    map[string]string

    Tags: Resource tags.

    version
    string

    Version: The version of the server.

    Server_Spec_ARM

    Field Description
    identity
    ResourceIdentity_ARM

    Identity: The Azure Active Directory identity of the server.

    location
    string

    Location: Resource location.

    name
    string
    properties
    ServerProperties_ARM

    Properties: Resource properties.

    tags
    map[string]string

    Tags: Resource tags.

    ServersAdministrator

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/ServerAzureADAdministrators.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​administrators/​{administratorName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_Administrator_Spec


    administratorType
    AdministratorProperties_AdministratorType

    AdministratorType: Type of the sever administrator.

    login
    string

    Login: Login name of the server administrator.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    sid
    string

    Sid: SID (object ID) of the server administrator.

    sidFromConfig
    genruntime.ConfigMapReference

    SidFromConfig: SID (object ID) of the server administrator.

    tenantId
    string

    TenantId: Tenant ID of the administrator.

    tenantIdFromConfig
    genruntime.ConfigMapReference

    TenantIdFromConfig: Tenant ID of the administrator.

    status
    Servers_Administrator_STATUS

    ServersAdvancedThreatProtectionSetting

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/ServerAdvancedThreatProtectionSettings.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​advancedThreatProtectionSettings/​Default

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_AdvancedThreatProtectionSetting_Spec


    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    state
    AdvancedThreatProtectionProperties_State

    State: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server.

    status
    Servers_AdvancedThreatProtectionSetting_STATUS

    ServersAuditingSetting

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/BlobAuditing.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​auditingSettings/​default

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_AuditingSetting_Spec


    auditActionsAndGroups
    []string

    AuditActionsAndGroups: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see Database-Level Audit Action Groups. For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see Database-Level Audit Actions

    isAzureMonitorTargetEnabled
    bool

    IsAzureMonitorTargetEnabled: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘State’ as ‘Enabled’ and ‘IsAzureMonitorTargetEnabled’ as true. When using REST API to configure auditing, Diagnostic Settings with ‘SQLSecurityAuditEvents’ diagnostic logs category on the database should be also created. Note that for server level audit you should use the ‘master’ database as {databaseName}. Diagnostic Settings URI format: PUT https:/​/​management.azure.com/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroup}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​{databaseName}/​providers/​microsoft.insights/​diagnosticSettings/​{settingsName}?api-version=2017-05-01-preview For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

    isDevopsAuditEnabled
    bool

    IsDevopsAuditEnabled: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘State’ as ‘Enabled’, ‘IsAzureMonitorTargetEnabled’ as true and ‘IsDevopsAuditEnabled’ as true When using REST API to configure auditing, Diagnostic Settings with ‘DevOpsOperationsAudit’ diagnostic logs category on the master database should also be created. Diagnostic Settings URI format: PUT https:/​/​management.azure.com/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroup}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​master/​providers/​microsoft.insights/​diagnosticSettings/​{settingsName}?api-version=2017-05-01-preview For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

    isManagedIdentityInUse
    bool

    IsManagedIdentityInUse: Specifies whether Managed Identity is used to access blob storage

    isStorageSecondaryKeyInUse
    bool

    IsStorageSecondaryKeyInUse: Specifies whether storageAccountAccessKey value is the storage’s secondary key.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    queueDelayMs
    int

    QueueDelayMs: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.

    retentionDays
    int

    RetentionDays: Specifies the number of days to keep in the audit logs in the storage account.

    state
    ServerBlobAuditingPolicyProperties_State

    State: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.

    storageAccountAccessKey
    genruntime.SecretReference

    StorageAccountAccessKey: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding ‘Storage Blob Data Contributor’ RBAC role to the server identity. For more information, see Auditing to storage using Managed Identity authentication

    storageAccountSubscriptionId
    string

    StorageAccountSubscriptionId: Specifies the blob storage subscription Id.

    storageEndpoint
    string

    StorageEndpoint: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.

    status
    Servers_AuditingSetting_STATUS

    ServersAzureADOnlyAuthentication

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/ServerAzureADOnlyAuthentications.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​azureADOnlyAuthentications/​Default

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_AzureADOnlyAuthentication_Spec


    azureADOnlyAuthentication
    bool

    AzureADOnlyAuthentication: Azure Active Directory only Authentication enabled.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    status
    Servers_AzureADOnlyAuthentication_STATUS

    ServersConnectionPolicy

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/ServerConnectionPolicies.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​connectionPolicies/​default

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_ConnectionPolicy_Spec


    connectionType
    ServerConnectionPolicyProperties_ConnectionType

    ConnectionType: The server connection type.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    status
    Servers_ConnectionPolicy_STATUS

    ServersDatabase

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/Databases.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​{databaseName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_Database_Spec


    autoPauseDelay
    int

    AutoPauseDelay: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled

    azureName
    string

    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.

    catalogCollation
    DatabaseProperties_CatalogCollation

    CatalogCollation: Collation of the metadata catalog.

    collation
    string

    Collation: The collation of the database.

    createMode
    DatabaseProperties_CreateMode

    CreateMode: Specifies the mode of database creation. Default: regular database creation. Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database. Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database. PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified. Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore. Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database’s original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time. RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID. Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition.

    elasticPoolReference
    genruntime.ResourceReference

    ElasticPoolReference: The resource identifier of the elastic pool containing this database.

    federatedClientId
    string

    FederatedClientId: The Client id used for cross tenant per database CMK scenario

    highAvailabilityReplicaCount
    int

    HighAvailabilityReplicaCount: The number of secondary replicas associated with the database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool.

    identity
    DatabaseIdentity

    Identity: The Azure Active Directory identity of the database.

    isLedgerOn
    bool

    IsLedgerOn: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.

    licenseType
    DatabaseProperties_LicenseType

    LicenseType: The license type to apply for this database. LicenseIncluded if you need a license, or BasePrice if you have a license and are eligible for the Azure Hybrid Benefit.

    location
    string

    Location: Resource location.

    longTermRetentionBackupResourceReference
    genruntime.ResourceReference

    LongTermRetentionBackupResourceReference: The resource identifier of the long term retention backup associated with create operation of this database.

    maintenanceConfigurationId
    string

    MaintenanceConfigurationId: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.

    maxSizeBytes
    int

    MaxSizeBytes: The max size of the database expressed in bytes.

    minCapacity
    float64

    MinCapacity: Minimal capacity that database will always have allocated, if not paused

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    readScale
    DatabaseProperties_ReadScale

    ReadScale: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool.

    recoverableDatabaseReference
    genruntime.ResourceReference

    RecoverableDatabaseReference: The resource identifier of the recoverable database associated with create operation of this database.

    recoveryServicesRecoveryPointReference
    genruntime.ResourceReference

    RecoveryServicesRecoveryPointReference: The resource identifier of the recovery point associated with create operation of this database.

    requestedBackupStorageRedundancy
    DatabaseProperties_RequestedBackupStorageRedundancy

    RequestedBackupStorageRedundancy: The storage account type to be used to store backups for this database.

    restorableDroppedDatabaseReference
    genruntime.ResourceReference

    RestorableDroppedDatabaseReference: The resource identifier of the restorable dropped database associated with create operation of this database.

    restorePointInTime
    string

    RestorePointInTime: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.

    sampleName
    DatabaseProperties_SampleName

    SampleName: The name of the sample schema to apply when creating this database.

    secondaryType
    DatabaseProperties_SecondaryType

    SecondaryType: The secondary type of the database if it is a secondary. Valid values are Geo and Named.

    sku
    Sku

    Sku: The database SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands: “`azurecli az sql db list-editions -l -o table

    ```powershell
    Get-AzSqlServerServiceObjective -Location <location>
    
    sourceDatabaseDeletionDate
    string

    SourceDatabaseDeletionDate: Specifies the time that the database was deleted.

    sourceDatabaseReference
    genruntime.ResourceReference

    SourceDatabaseReference: The resource identifier of the source database associated with create operation of this database.

    sourceResourceReference
    genruntime.ResourceReference

    SourceResourceReference: The resource identifier of the source associated with the create operation of this database. This property is only supported for DataWarehouse edition and allows to restore across subscriptions. When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of the existing database or existing sql pool, and restorePointInTime must be specified. When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant

    tags
    map[string]string

    Tags: Resource tags.

    zoneRedundant
    bool

    ZoneRedundant: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.

    status
    Servers_Database_STATUS

    ServersDatabasesAdvancedThreatProtectionSetting

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/DatabaseAdvancedThreatProtectionSettings.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​{databaseName}/​advancedThreatProtectionSettings/​Default

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_Databases_AdvancedThreatProtectionSetting_Spec


    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/ServersDatabase resource

    state
    AdvancedThreatProtectionProperties_State

    State: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server.

    status
    Servers_Databases_AdvancedThreatProtectionSetting_STATUS

    ServersDatabasesAuditingSetting

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/BlobAuditing.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​{databaseName}/​auditingSettings/​default

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_Databases_AuditingSetting_Spec


    auditActionsAndGroups
    []string

    AuditActionsAndGroups: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see Database-Level Audit Action Groups. For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see Database-Level Audit Actions

    isAzureMonitorTargetEnabled
    bool

    IsAzureMonitorTargetEnabled: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘State’ as ‘Enabled’ and ‘IsAzureMonitorTargetEnabled’ as true. When using REST API to configure auditing, Diagnostic Settings with ‘SQLSecurityAuditEvents’ diagnostic logs category on the database should be also created. Note that for server level audit you should use the ‘master’ database as {databaseName}. Diagnostic Settings URI format: PUT https:/​/​management.azure.com/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroup}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​{databaseName}/​providers/​microsoft.insights/​diagnosticSettings/​{settingsName}?api-version=2017-05-01-preview For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

    isManagedIdentityInUse
    bool

    IsManagedIdentityInUse: Specifies whether Managed Identity is used to access blob storage

    isStorageSecondaryKeyInUse
    bool

    IsStorageSecondaryKeyInUse: Specifies whether storageAccountAccessKey value is the storage’s secondary key.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/ServersDatabase resource

    queueDelayMs
    int

    QueueDelayMs: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.

    retentionDays
    int

    RetentionDays: Specifies the number of days to keep in the audit logs in the storage account.

    state
    DatabaseBlobAuditingPolicyProperties_State

    State: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.

    storageAccountAccessKey
    genruntime.SecretReference

    StorageAccountAccessKey: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding ‘Storage Blob Data Contributor’ RBAC role to the server identity. For more information, see Auditing to storage using Managed Identity authentication

    storageAccountSubscriptionId
    string

    StorageAccountSubscriptionId: Specifies the blob storage subscription Id.

    storageEndpoint
    string

    StorageEndpoint: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.

    status
    Servers_Databases_AuditingSetting_STATUS

    ServersDatabasesBackupLongTermRetentionPolicy

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/LongTermRetentionPolicies.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​{databaseName}/​backupLongTermRetentionPolicies/​default

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_Databases_BackupLongTermRetentionPolicy_Spec


    monthlyRetention
    string

    MonthlyRetention: The monthly retention policy for an LTR backup in an ISO 8601 format.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/ServersDatabase resource

    weekOfYear
    int

    WeekOfYear: The week of year to take the yearly backup in an ISO 8601 format.

    weeklyRetention
    string

    WeeklyRetention: The weekly retention policy for an LTR backup in an ISO 8601 format.

    yearlyRetention
    string

    YearlyRetention: The yearly retention policy for an LTR backup in an ISO 8601 format.

    status
    Servers_Databases_BackupLongTermRetentionPolicy_STATUS

    ServersDatabasesBackupShortTermRetentionPolicy

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/BackupShortTermRetentionPolicies.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​{databaseName}/​backupShortTermRetentionPolicies/​default

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_Databases_BackupShortTermRetentionPolicy_Spec


    diffBackupIntervalInHours
    BackupShortTermRetentionPolicyProperties_DiffBackupIntervalInHours

    DiffBackupIntervalInHours: The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/ServersDatabase resource

    retentionDays
    int

    RetentionDays: The backup retention period in days. This is how many days Point-in-Time Restore will be supported.

    status
    Servers_Databases_BackupShortTermRetentionPolicy_STATUS

    ServersDatabasesSecurityAlertPolicy

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/DatabaseSecurityAlertPolicies.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​{databaseName}/​securityAlertPolicies/​default

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_Databases_SecurityAlertPolicy_Spec


    disabledAlerts
    []string

    DisabledAlerts: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force

    emailAccountAdmins
    bool

    EmailAccountAdmins: Specifies that the alert is sent to the account administrators.

    emailAddresses
    []string

    EmailAddresses: Specifies an array of e-mail addresses to which the alert is sent.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/ServersDatabase resource

    retentionDays
    int

    RetentionDays: Specifies the number of days to keep in the Threat Detection audit logs.

    state
    DatabaseSecurityAlertPoliciesSecurityAlertsPolicyProperties_State

    State: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.

    storageAccountAccessKey
    genruntime.SecretReference

    StorageAccountAccessKey: Specifies the identifier key of the Threat Detection audit storage account.

    storageEndpoint
    string

    StorageEndpoint: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

    status
    Servers_Databases_SecurityAlertPolicy_STATUS

    ServersDatabasesTransparentDataEncryption

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/TransparentDataEncryptions.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​{databaseName}/​transparentDataEncryption/​{tdeName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_Databases_TransparentDataEncryption_Spec


    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/ServersDatabase resource

    state
    TransparentDataEncryptionProperties_State

    State: Specifies the state of the transparent data encryption.

    status
    Servers_Databases_TransparentDataEncryption_STATUS

    ServersDatabasesVulnerabilityAssessment

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/DatabaseVulnerabilityAssessments.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​{databaseName}/​vulnerabilityAssessments/​default

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_Databases_VulnerabilityAssessment_Spec


    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/ServersDatabase resource

    recurringScans
    VulnerabilityAssessmentRecurringScansProperties

    RecurringScans: The recurring scans settings

    storageAccountAccessKey
    genruntime.SecretReference

    StorageAccountAccessKey: Specifies the identifier key of the storage account for vulnerability assessment scan results. If ‘StorageContainerSasKey’ isn’t specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall

    storageContainerPath
    string

    StorageContainerPath: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn’t set

    storageContainerPathFromConfig
    genruntime.ConfigMapReference

    StorageContainerPathFromConfig: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn’t set

    storageContainerSasKey
    genruntime.SecretReference

    StorageContainerSasKey: A shared access signature (SAS Key) that has write access to the blob container specified in ‘storageContainerPath’ parameter. If ‘storageAccountAccessKey’ isn’t specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall

    status
    Servers_Databases_VulnerabilityAssessment_STATUS

    ServersElasticPool

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/ElasticPools.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​elasticPools/​{elasticPoolName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_ElasticPool_Spec


    azureName
    string

    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.

    highAvailabilityReplicaCount
    int

    HighAvailabilityReplicaCount: The number of secondary replicas associated with the elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.

    licenseType
    ElasticPoolProperties_LicenseType

    LicenseType: The license type to apply for this elastic pool.

    location
    string

    Location: Resource location.

    maintenanceConfigurationId
    string

    MaintenanceConfigurationId: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.

    maxSizeBytes
    int

    MaxSizeBytes: The storage limit for the database elastic pool in bytes.

    minCapacity
    float64

    MinCapacity: Minimal capacity that serverless pool will not shrink below, if not paused

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    perDatabaseSettings
    ElasticPoolPerDatabaseSettings

    PerDatabaseSettings: The per database settings for the elastic pool.

    sku
    Sku

    Sku: The elastic pool SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or the following command: azurecli az sql elastic-pool list-editions -l <location> -o table `

    tags
    map[string]string

    Tags: Resource tags.

    zoneRedundant
    bool

    ZoneRedundant: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.

    status
    Servers_ElasticPool_STATUS

    ServersFailoverGroup

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/FailoverGroups.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​failoverGroups/​{failoverGroupName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_FailoverGroup_Spec


    azureName
    string

    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.

    databasesReferences
    []genruntime.ResourceReference

    DatabasesReferences: List of databases in the failover group.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    partnerServers
    []PartnerInfo

    PartnerServers: List of partner server information for the failover group.

    readOnlyEndpoint
    FailoverGroupReadOnlyEndpoint

    ReadOnlyEndpoint: Read-only endpoint of the failover group instance.

    readWriteEndpoint
    FailoverGroupReadWriteEndpoint

    ReadWriteEndpoint: Read-write endpoint of the failover group instance.

    tags
    map[string]string

    Tags: Resource tags.

    status
    Servers_FailoverGroup_STATUS

    ServersFirewallRule

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/FirewallRules.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​firewallRules/​{firewallRuleName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_FirewallRule_Spec


    azureName
    string

    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.

    endIpAddress
    string

    EndIpAddress: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value ‘0.0.0.0’ for all Azure-internal IP addresses.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    startIpAddress
    string

    StartIpAddress: The start IP address of the firewall rule. Must be IPv4 format. Use value ‘0.0.0.0’ for all Azure-internal IP addresses.

    status
    Servers_FirewallRule_STATUS

    ServersIPV6FirewallRule

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/IPv6FirewallRules.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​ipv6FirewallRules/​{firewallRuleName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_Ipv6FirewallRule_Spec


    azureName
    string

    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.

    endIPv6Address
    string

    EndIPv6Address: The end IP address of the firewall rule. Must be IPv6 format. Must be greater than or equal to startIpAddress.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    startIPv6Address
    string

    StartIPv6Address: The start IP address of the firewall rule. Must be IPv6 format.

    status
    Servers_Ipv6FirewallRule_STATUS

    ServersOutboundFirewallRule

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/OutboundFirewallRules.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​outboundFirewallRules/​{outboundRuleFqdn}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_OutboundFirewallRule_Spec


    azureName
    string

    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.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    status
    Servers_OutboundFirewallRule_STATUS

    ServersSecurityAlertPolicy

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/ServerSecurityAlertPolicies.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​securityAlertPolicies/​Default

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_SecurityAlertPolicy_Spec


    disabledAlerts
    []string

    DisabledAlerts: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force

    emailAccountAdmins
    bool

    EmailAccountAdmins: Specifies that the alert is sent to the account administrators.

    emailAddresses
    []string

    EmailAddresses: Specifies an array of e-mail addresses to which the alert is sent.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    retentionDays
    int

    RetentionDays: Specifies the number of days to keep in the Threat Detection audit logs.

    state
    ServerSecurityAlertPoliciesSecurityAlertsPolicyProperties_State

    State: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.

    storageAccountAccessKey
    genruntime.SecretReference

    StorageAccountAccessKey: Specifies the identifier key of the Threat Detection audit storage account.

    storageEndpoint
    string

    StorageEndpoint: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

    status
    Servers_SecurityAlertPolicy_STATUS

    ServersVirtualNetworkRule

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/VirtualNetworkRules.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​virtualNetworkRules/​{virtualNetworkRuleName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_VirtualNetworkRule_Spec


    azureName
    string

    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.

    ignoreMissingVnetServiceEndpoint
    bool

    IgnoreMissingVnetServiceEndpoint: Create firewall rule before the virtual network has vnet service endpoint enabled.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    virtualNetworkSubnetReference
    genruntime.ResourceReference

    VirtualNetworkSubnetReference: The ARM resource id of the virtual network subnet.

    status
    Servers_VirtualNetworkRule_STATUS

    ServersVulnerabilityAssessment

    Generator information: - Generated from: /sql/resource-manager/Microsoft.Sql/stable/2021-11-01/ServerVulnerabilityAssessments.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Sql/​servers/​{serverName}/​vulnerabilityAssessments/​default

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Servers_VulnerabilityAssessment_Spec


    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    recurringScans
    VulnerabilityAssessmentRecurringScansProperties

    RecurringScans: The recurring scans settings

    storageAccountAccessKey
    genruntime.SecretReference

    StorageAccountAccessKey: Specifies the identifier key of the storage account for vulnerability assessment scan results. If ‘StorageContainerSasKey’ isn’t specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall

    storageContainerPath
    string

    StorageContainerPath: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).

    storageContainerPathFromConfig
    genruntime.ConfigMapReference

    StorageContainerPathFromConfig: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).

    storageContainerSasKey
    genruntime.SecretReference

    StorageContainerSasKey: A shared access signature (SAS Key) that has write access to the blob container specified in ‘storageContainerPath’ parameter. If ‘storageAccountAccessKey’ isn’t specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall

    status
    Servers_VulnerabilityAssessment_STATUS

    Servers_Administrator_STATUS

    (Appears on:ServersAdministrator)

    Field Description
    administratorType
    AdministratorProperties_AdministratorType_STATUS

    AdministratorType: Type of the sever administrator.

    azureADOnlyAuthentication
    bool

    AzureADOnlyAuthentication: Azure Active Directory only Authentication enabled.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    id
    string

    Id: Resource ID.

    login
    string

    Login: Login name of the server administrator.

    name
    string

    Name: Resource name.

    sid
    string

    Sid: SID (object ID) of the server administrator.

    tenantId
    string

    TenantId: Tenant ID of the administrator.

    type
    string

    Type: Resource type.

    Servers_Administrator_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    properties
    AdministratorProperties_STATUS_ARM

    Properties: Resource properties.

    type
    string

    Type: Resource type.

    Servers_Administrator_Spec

    (Appears on:ServersAdministrator)

    Field Description
    administratorType
    AdministratorProperties_AdministratorType

    AdministratorType: Type of the sever administrator.

    login
    string

    Login: Login name of the server administrator.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    sid
    string

    Sid: SID (object ID) of the server administrator.

    sidFromConfig
    genruntime.ConfigMapReference

    SidFromConfig: SID (object ID) of the server administrator.

    tenantId
    string

    TenantId: Tenant ID of the administrator.

    tenantIdFromConfig
    genruntime.ConfigMapReference

    TenantIdFromConfig: Tenant ID of the administrator.

    Servers_Administrator_Spec_ARM

    Field Description
    name
    string
    properties
    AdministratorProperties_ARM

    Properties: Resource properties.

    Servers_AdvancedThreatProtectionSetting_STATUS

    (Appears on:ServersAdvancedThreatProtectionSetting)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    creationTime
    string

    CreationTime: Specifies the UTC creation time of the policy.

    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    state
    AdvancedThreatProtectionProperties_State_STATUS

    State: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server.

    systemData
    SystemData_STATUS

    SystemData: SystemData of AdvancedThreatProtectionResource.

    type
    string

    Type: Resource type.

    Servers_AdvancedThreatProtectionSetting_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    properties
    AdvancedThreatProtectionProperties_STATUS_ARM

    Properties: Resource properties.

    systemData
    SystemData_STATUS_ARM

    SystemData: SystemData of AdvancedThreatProtectionResource.

    type
    string

    Type: Resource type.

    Servers_AdvancedThreatProtectionSetting_Spec

    (Appears on:ServersAdvancedThreatProtectionSetting)

    Field Description
    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    state
    AdvancedThreatProtectionProperties_State

    State: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server.

    Servers_AdvancedThreatProtectionSetting_Spec_ARM

    Field Description
    name
    string
    properties
    AdvancedThreatProtectionProperties_ARM

    Properties: Resource properties.

    Servers_AuditingSetting_STATUS

    (Appears on:ServersAuditingSetting)

    Field Description
    auditActionsAndGroups
    []string

    AuditActionsAndGroups: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see Database-Level Audit Action Groups. For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see Database-Level Audit Actions

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    id
    string

    Id: Resource ID.

    isAzureMonitorTargetEnabled
    bool

    IsAzureMonitorTargetEnabled: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘State’ as ‘Enabled’ and ‘IsAzureMonitorTargetEnabled’ as true. When using REST API to configure auditing, Diagnostic Settings with ‘SQLSecurityAuditEvents’ diagnostic logs category on the database should be also created. Note that for server level audit you should use the ‘master’ database as {databaseName}. Diagnostic Settings URI format: PUT https:/​/​management.azure.com/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroup}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​{databaseName}/​providers/​microsoft.insights/​diagnosticSettings/​{settingsName}?api-version=2017-05-01-preview For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

    isDevopsAuditEnabled
    bool

    IsDevopsAuditEnabled: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘State’ as ‘Enabled’, ‘IsAzureMonitorTargetEnabled’ as true and ‘IsDevopsAuditEnabled’ as true When using REST API to configure auditing, Diagnostic Settings with ‘DevOpsOperationsAudit’ diagnostic logs category on the master database should also be created. Diagnostic Settings URI format: PUT https:/​/​management.azure.com/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroup}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​master/​providers/​microsoft.insights/​diagnosticSettings/​{settingsName}?api-version=2017-05-01-preview For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

    isManagedIdentityInUse
    bool

    IsManagedIdentityInUse: Specifies whether Managed Identity is used to access blob storage

    isStorageSecondaryKeyInUse
    bool

    IsStorageSecondaryKeyInUse: Specifies whether storageAccountAccessKey value is the storage’s secondary key.

    name
    string

    Name: Resource name.

    queueDelayMs
    int

    QueueDelayMs: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.

    retentionDays
    int

    RetentionDays: Specifies the number of days to keep in the audit logs in the storage account.

    state
    ServerBlobAuditingPolicyProperties_State_STATUS

    State: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.

    storageAccountSubscriptionId
    string

    StorageAccountSubscriptionId: Specifies the blob storage subscription Id.

    storageEndpoint
    string

    StorageEndpoint: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.

    type
    string

    Type: Resource type.

    Servers_AuditingSetting_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    properties
    ServerBlobAuditingPolicyProperties_STATUS_ARM

    Properties: Resource properties.

    type
    string

    Type: Resource type.

    Servers_AuditingSetting_Spec

    (Appears on:ServersAuditingSetting)

    Field Description
    auditActionsAndGroups
    []string

    AuditActionsAndGroups: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see Database-Level Audit Action Groups. For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see Database-Level Audit Actions

    isAzureMonitorTargetEnabled
    bool

    IsAzureMonitorTargetEnabled: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘State’ as ‘Enabled’ and ‘IsAzureMonitorTargetEnabled’ as true. When using REST API to configure auditing, Diagnostic Settings with ‘SQLSecurityAuditEvents’ diagnostic logs category on the database should be also created. Note that for server level audit you should use the ‘master’ database as {databaseName}. Diagnostic Settings URI format: PUT https:/​/​management.azure.com/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroup}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​{databaseName}/​providers/​microsoft.insights/​diagnosticSettings/​{settingsName}?api-version=2017-05-01-preview For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

    isDevopsAuditEnabled
    bool

    IsDevopsAuditEnabled: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘State’ as ‘Enabled’, ‘IsAzureMonitorTargetEnabled’ as true and ‘IsDevopsAuditEnabled’ as true When using REST API to configure auditing, Diagnostic Settings with ‘DevOpsOperationsAudit’ diagnostic logs category on the master database should also be created. Diagnostic Settings URI format: PUT https:/​/​management.azure.com/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroup}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​master/​providers/​microsoft.insights/​diagnosticSettings/​{settingsName}?api-version=2017-05-01-preview For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

    isManagedIdentityInUse
    bool

    IsManagedIdentityInUse: Specifies whether Managed Identity is used to access blob storage

    isStorageSecondaryKeyInUse
    bool

    IsStorageSecondaryKeyInUse: Specifies whether storageAccountAccessKey value is the storage’s secondary key.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    queueDelayMs
    int

    QueueDelayMs: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.

    retentionDays
    int

    RetentionDays: Specifies the number of days to keep in the audit logs in the storage account.

    state
    ServerBlobAuditingPolicyProperties_State

    State: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.

    storageAccountAccessKey
    genruntime.SecretReference

    StorageAccountAccessKey: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding ‘Storage Blob Data Contributor’ RBAC role to the server identity. For more information, see Auditing to storage using Managed Identity authentication

    storageAccountSubscriptionId
    string

    StorageAccountSubscriptionId: Specifies the blob storage subscription Id.

    storageEndpoint
    string

    StorageEndpoint: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.

    Servers_AuditingSetting_Spec_ARM

    Field Description
    name
    string
    properties
    ServerBlobAuditingPolicyProperties_ARM

    Properties: Resource properties.

    Servers_AzureADOnlyAuthentication_STATUS

    (Appears on:ServersAzureADOnlyAuthentication)

    Field Description
    azureADOnlyAuthentication
    bool

    AzureADOnlyAuthentication: Azure Active Directory only Authentication enabled.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    type
    string

    Type: Resource type.

    Servers_AzureADOnlyAuthentication_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    properties
    AzureADOnlyAuthProperties_STATUS_ARM

    Properties: Resource properties.

    type
    string

    Type: Resource type.

    Servers_AzureADOnlyAuthentication_Spec

    (Appears on:ServersAzureADOnlyAuthentication)

    Field Description
    azureADOnlyAuthentication
    bool

    AzureADOnlyAuthentication: Azure Active Directory only Authentication enabled.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    Servers_AzureADOnlyAuthentication_Spec_ARM

    Field Description
    name
    string
    properties
    AzureADOnlyAuthProperties_ARM

    Properties: Resource properties.

    Servers_ConnectionPolicy_STATUS

    (Appears on:ServersConnectionPolicy)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    connectionType
    ServerConnectionPolicyProperties_ConnectionType_STATUS

    ConnectionType: The server connection type.

    id
    string

    Id: Resource ID.

    kind
    string

    Kind: Metadata used for the Azure portal experience.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    type
    string

    Type: Resource type.

    Servers_ConnectionPolicy_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    kind
    string

    Kind: Metadata used for the Azure portal experience.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    properties
    ServerConnectionPolicyProperties_STATUS_ARM

    Properties: Resource properties.

    type
    string

    Type: Resource type.

    Servers_ConnectionPolicy_Spec

    (Appears on:ServersConnectionPolicy)

    Field Description
    connectionType
    ServerConnectionPolicyProperties_ConnectionType

    ConnectionType: The server connection type.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    Servers_ConnectionPolicy_Spec_ARM

    Field Description
    name
    string
    properties
    ServerConnectionPolicyProperties_ARM

    Properties: Resource properties.

    Servers_Database_STATUS

    (Appears on:ServersDatabase)

    Field Description
    autoPauseDelay
    int

    AutoPauseDelay: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled

    catalogCollation
    DatabaseProperties_CatalogCollation_STATUS

    CatalogCollation: Collation of the metadata catalog.

    collation
    string

    Collation: The collation of the database.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    createMode
    DatabaseProperties_CreateMode_STATUS

    CreateMode: Specifies the mode of database creation. Default: regular database creation. Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database. Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database. PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified. Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore. Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database’s original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time. RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID. Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition.

    creationDate
    string

    CreationDate: The creation date of the database (ISO8601 format).

    currentBackupStorageRedundancy
    DatabaseProperties_CurrentBackupStorageRedundancy_STATUS

    CurrentBackupStorageRedundancy: The storage account type used to store backups for this database.

    currentServiceObjectiveName
    string

    CurrentServiceObjectiveName: The current service level objective name of the database.

    currentSku
    Sku_STATUS

    CurrentSku: The name and tier of the SKU.

    databaseId
    string

    DatabaseId: The ID of the database.

    defaultSecondaryLocation
    string

    DefaultSecondaryLocation: The default secondary region for this database.

    earliestRestoreDate
    string

    EarliestRestoreDate: This records the earliest start date and time that restore is available for this database (ISO8601 format).

    elasticPoolId
    string

    ElasticPoolId: The resource identifier of the elastic pool containing this database.

    failoverGroupId
    string

    FailoverGroupId: Failover Group resource identifier that this database belongs to.

    federatedClientId
    string

    FederatedClientId: The Client id used for cross tenant per database CMK scenario

    highAvailabilityReplicaCount
    int

    HighAvailabilityReplicaCount: The number of secondary replicas associated with the database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool.

    id
    string

    Id: Resource ID.

    identity
    DatabaseIdentity_STATUS

    Identity: The Azure Active Directory identity of the database.

    isInfraEncryptionEnabled
    bool

    IsInfraEncryptionEnabled: Infra encryption is enabled for this database.

    isLedgerOn
    bool

    IsLedgerOn: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.

    kind
    string

    Kind: Kind of database. This is metadata used for the Azure portal experience.

    licenseType
    DatabaseProperties_LicenseType_STATUS

    LicenseType: The license type to apply for this database. LicenseIncluded if you need a license, or BasePrice if you have a license and are eligible for the Azure Hybrid Benefit.

    location
    string

    Location: Resource location.

    longTermRetentionBackupResourceId
    string

    LongTermRetentionBackupResourceId: The resource identifier of the long term retention backup associated with create operation of this database.

    maintenanceConfigurationId
    string

    MaintenanceConfigurationId: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.

    managedBy
    string

    ManagedBy: Resource that manages the database.

    maxLogSizeBytes
    int

    MaxLogSizeBytes: The max log size for this database.

    maxSizeBytes
    int

    MaxSizeBytes: The max size of the database expressed in bytes.

    minCapacity
    float64

    MinCapacity: Minimal capacity that database will always have allocated, if not paused

    name
    string

    Name: Resource name.

    pausedDate
    string

    PausedDate: The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready.

    readScale
    DatabaseProperties_ReadScale_STATUS

    ReadScale: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool.

    recoverableDatabaseId
    string

    RecoverableDatabaseId: The resource identifier of the recoverable database associated with create operation of this database.

    recoveryServicesRecoveryPointId
    string

    RecoveryServicesRecoveryPointId: The resource identifier of the recovery point associated with create operation of this database.

    requestedBackupStorageRedundancy
    DatabaseProperties_RequestedBackupStorageRedundancy_STATUS

    RequestedBackupStorageRedundancy: The storage account type to be used to store backups for this database.

    requestedServiceObjectiveName
    string

    RequestedServiceObjectiveName: The requested service level objective name of the database.

    restorableDroppedDatabaseId
    string

    RestorableDroppedDatabaseId: The resource identifier of the restorable dropped database associated with create operation of this database.

    restorePointInTime
    string

    RestorePointInTime: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.

    resumedDate
    string

    ResumedDate: The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused.

    sampleName
    DatabaseProperties_SampleName_STATUS

    SampleName: The name of the sample schema to apply when creating this database.

    secondaryType
    DatabaseProperties_SecondaryType_STATUS

    SecondaryType: The secondary type of the database if it is a secondary. Valid values are Geo and Named.

    sku
    Sku_STATUS

    Sku: The database SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands: “`azurecli az sql db list-editions -l -o table

    ```powershell
    Get-AzSqlServerServiceObjective -Location <location>
    
    sourceDatabaseDeletionDate
    string

    SourceDatabaseDeletionDate: Specifies the time that the database was deleted.

    sourceDatabaseId
    string

    SourceDatabaseId: The resource identifier of the source database associated with create operation of this database.

    sourceResourceId
    string

    SourceResourceId: The resource identifier of the source associated with the create operation of this database. This property is only supported for DataWarehouse edition and allows to restore across subscriptions. When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of the existing database or existing sql pool, and restorePointInTime must be specified. When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant

    status
    DatabaseProperties_Status_STATUS

    Status: The status of the database.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    zoneRedundant
    bool

    ZoneRedundant: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.

    Servers_Database_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    identity
    DatabaseIdentity_STATUS_ARM

    Identity: The Azure Active Directory identity of the database.

    kind
    string

    Kind: Kind of database. This is metadata used for the Azure portal experience.

    location
    string

    Location: Resource location.

    managedBy
    string

    ManagedBy: Resource that manages the database.

    name
    string

    Name: Resource name.

    properties
    DatabaseProperties_STATUS_ARM

    Properties: Resource properties.

    sku
    Sku_STATUS_ARM

    Sku: The database SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands: “`azurecli az sql db list-editions -l -o table

    ```powershell
    Get-AzSqlServerServiceObjective -Location <location>
    
    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    Servers_Database_Spec

    (Appears on:ServersDatabase)

    Field Description
    autoPauseDelay
    int

    AutoPauseDelay: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled

    azureName
    string

    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.

    catalogCollation
    DatabaseProperties_CatalogCollation

    CatalogCollation: Collation of the metadata catalog.

    collation
    string

    Collation: The collation of the database.

    createMode
    DatabaseProperties_CreateMode

    CreateMode: Specifies the mode of database creation. Default: regular database creation. Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database. Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database. PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified. Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore. Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database’s original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time. RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID. Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition.

    elasticPoolReference
    genruntime.ResourceReference

    ElasticPoolReference: The resource identifier of the elastic pool containing this database.

    federatedClientId
    string

    FederatedClientId: The Client id used for cross tenant per database CMK scenario

    highAvailabilityReplicaCount
    int

    HighAvailabilityReplicaCount: The number of secondary replicas associated with the database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool.

    identity
    DatabaseIdentity

    Identity: The Azure Active Directory identity of the database.

    isLedgerOn
    bool

    IsLedgerOn: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.

    licenseType
    DatabaseProperties_LicenseType

    LicenseType: The license type to apply for this database. LicenseIncluded if you need a license, or BasePrice if you have a license and are eligible for the Azure Hybrid Benefit.

    location
    string

    Location: Resource location.

    longTermRetentionBackupResourceReference
    genruntime.ResourceReference

    LongTermRetentionBackupResourceReference: The resource identifier of the long term retention backup associated with create operation of this database.

    maintenanceConfigurationId
    string

    MaintenanceConfigurationId: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.

    maxSizeBytes
    int

    MaxSizeBytes: The max size of the database expressed in bytes.

    minCapacity
    float64

    MinCapacity: Minimal capacity that database will always have allocated, if not paused

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    readScale
    DatabaseProperties_ReadScale

    ReadScale: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool.

    recoverableDatabaseReference
    genruntime.ResourceReference

    RecoverableDatabaseReference: The resource identifier of the recoverable database associated with create operation of this database.

    recoveryServicesRecoveryPointReference
    genruntime.ResourceReference

    RecoveryServicesRecoveryPointReference: The resource identifier of the recovery point associated with create operation of this database.

    requestedBackupStorageRedundancy
    DatabaseProperties_RequestedBackupStorageRedundancy

    RequestedBackupStorageRedundancy: The storage account type to be used to store backups for this database.

    restorableDroppedDatabaseReference
    genruntime.ResourceReference

    RestorableDroppedDatabaseReference: The resource identifier of the restorable dropped database associated with create operation of this database.

    restorePointInTime
    string

    RestorePointInTime: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.

    sampleName
    DatabaseProperties_SampleName

    SampleName: The name of the sample schema to apply when creating this database.

    secondaryType
    DatabaseProperties_SecondaryType

    SecondaryType: The secondary type of the database if it is a secondary. Valid values are Geo and Named.

    sku
    Sku

    Sku: The database SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands: “`azurecli az sql db list-editions -l -o table

    ```powershell
    Get-AzSqlServerServiceObjective -Location <location>
    
    sourceDatabaseDeletionDate
    string

    SourceDatabaseDeletionDate: Specifies the time that the database was deleted.

    sourceDatabaseReference
    genruntime.ResourceReference

    SourceDatabaseReference: The resource identifier of the source database associated with create operation of this database.

    sourceResourceReference
    genruntime.ResourceReference

    SourceResourceReference: The resource identifier of the source associated with the create operation of this database. This property is only supported for DataWarehouse edition and allows to restore across subscriptions. When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of the existing database or existing sql pool, and restorePointInTime must be specified. When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant

    tags
    map[string]string

    Tags: Resource tags.

    zoneRedundant
    bool

    ZoneRedundant: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.

    Servers_Database_Spec_ARM

    Field Description
    identity
    DatabaseIdentity_ARM

    Identity: The Azure Active Directory identity of the database.

    location
    string

    Location: Resource location.

    name
    string
    properties
    DatabaseProperties_ARM

    Properties: Resource properties.

    sku
    Sku_ARM

    Sku: The database SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands: “`azurecli az sql db list-editions -l -o table

    ```powershell
    Get-AzSqlServerServiceObjective -Location <location>
    
    tags
    map[string]string

    Tags: Resource tags.

    Servers_Databases_AdvancedThreatProtectionSetting_STATUS

    (Appears on:ServersDatabasesAdvancedThreatProtectionSetting)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    creationTime
    string

    CreationTime: Specifies the UTC creation time of the policy.

    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    state
    AdvancedThreatProtectionProperties_State_STATUS

    State: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server.

    systemData
    SystemData_STATUS

    SystemData: SystemData of AdvancedThreatProtectionResource.

    type
    string

    Type: Resource type.

    Servers_Databases_AdvancedThreatProtectionSetting_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    properties
    AdvancedThreatProtectionProperties_STATUS_ARM

    Properties: Resource properties.

    systemData
    SystemData_STATUS_ARM

    SystemData: SystemData of AdvancedThreatProtectionResource.

    type
    string

    Type: Resource type.

    Servers_Databases_AdvancedThreatProtectionSetting_Spec

    (Appears on:ServersDatabasesAdvancedThreatProtectionSetting)

    Field Description
    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/ServersDatabase resource

    state
    AdvancedThreatProtectionProperties_State

    State: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server.

    Servers_Databases_AdvancedThreatProtectionSetting_Spec_ARM

    Field Description
    name
    string
    properties
    AdvancedThreatProtectionProperties_ARM

    Properties: Resource properties.

    Servers_Databases_AuditingSetting_STATUS

    (Appears on:ServersDatabasesAuditingSetting)

    Field Description
    auditActionsAndGroups
    []string

    AuditActionsAndGroups: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see Database-Level Audit Action Groups. For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see Database-Level Audit Actions

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    id
    string

    Id: Resource ID.

    isAzureMonitorTargetEnabled
    bool

    IsAzureMonitorTargetEnabled: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘State’ as ‘Enabled’ and ‘IsAzureMonitorTargetEnabled’ as true. When using REST API to configure auditing, Diagnostic Settings with ‘SQLSecurityAuditEvents’ diagnostic logs category on the database should be also created. Note that for server level audit you should use the ‘master’ database as {databaseName}. Diagnostic Settings URI format: PUT https:/​/​management.azure.com/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroup}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​{databaseName}/​providers/​microsoft.insights/​diagnosticSettings/​{settingsName}?api-version=2017-05-01-preview For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

    isManagedIdentityInUse
    bool

    IsManagedIdentityInUse: Specifies whether Managed Identity is used to access blob storage

    isStorageSecondaryKeyInUse
    bool

    IsStorageSecondaryKeyInUse: Specifies whether storageAccountAccessKey value is the storage’s secondary key.

    kind
    string

    Kind: Resource kind.

    name
    string

    Name: Resource name.

    queueDelayMs
    int

    QueueDelayMs: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.

    retentionDays
    int

    RetentionDays: Specifies the number of days to keep in the audit logs in the storage account.

    state
    DatabaseBlobAuditingPolicyProperties_State_STATUS

    State: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.

    storageAccountSubscriptionId
    string

    StorageAccountSubscriptionId: Specifies the blob storage subscription Id.

    storageEndpoint
    string

    StorageEndpoint: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.

    type
    string

    Type: Resource type.

    Servers_Databases_AuditingSetting_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    kind
    string

    Kind: Resource kind.

    name
    string

    Name: Resource name.

    properties
    DatabaseBlobAuditingPolicyProperties_STATUS_ARM

    Properties: Resource properties.

    type
    string

    Type: Resource type.

    Servers_Databases_AuditingSetting_Spec

    (Appears on:ServersDatabasesAuditingSetting)

    Field Description
    auditActionsAndGroups
    []string

    AuditActionsAndGroups: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see Database-Level Audit Action Groups. For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see Database-Level Audit Actions

    isAzureMonitorTargetEnabled
    bool

    IsAzureMonitorTargetEnabled: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘State’ as ‘Enabled’ and ‘IsAzureMonitorTargetEnabled’ as true. When using REST API to configure auditing, Diagnostic Settings with ‘SQLSecurityAuditEvents’ diagnostic logs category on the database should be also created. Note that for server level audit you should use the ‘master’ database as {databaseName}. Diagnostic Settings URI format: PUT https:/​/​management.azure.com/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroup}/​providers/​Microsoft.Sql/​servers/​{serverName}/​databases/​{databaseName}/​providers/​microsoft.insights/​diagnosticSettings/​{settingsName}?api-version=2017-05-01-preview For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

    isManagedIdentityInUse
    bool

    IsManagedIdentityInUse: Specifies whether Managed Identity is used to access blob storage

    isStorageSecondaryKeyInUse
    bool

    IsStorageSecondaryKeyInUse: Specifies whether storageAccountAccessKey value is the storage’s secondary key.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/ServersDatabase resource

    queueDelayMs
    int

    QueueDelayMs: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.

    retentionDays
    int

    RetentionDays: Specifies the number of days to keep in the audit logs in the storage account.

    state
    DatabaseBlobAuditingPolicyProperties_State

    State: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.

    storageAccountAccessKey
    genruntime.SecretReference

    StorageAccountAccessKey: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding ‘Storage Blob Data Contributor’ RBAC role to the server identity. For more information, see Auditing to storage using Managed Identity authentication

    storageAccountSubscriptionId
    string

    StorageAccountSubscriptionId: Specifies the blob storage subscription Id.

    storageEndpoint
    string

    StorageEndpoint: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.

    Servers_Databases_AuditingSetting_Spec_ARM

    Field Description
    name
    string
    properties
    DatabaseBlobAuditingPolicyProperties_ARM

    Properties: Resource properties.

    Servers_Databases_BackupLongTermRetentionPolicy_STATUS

    (Appears on:ServersDatabasesBackupLongTermRetentionPolicy)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    id
    string

    Id: Resource ID.

    monthlyRetention
    string

    MonthlyRetention: The monthly retention policy for an LTR backup in an ISO 8601 format.

    name
    string

    Name: Resource name.

    type
    string

    Type: Resource type.

    weekOfYear
    int

    WeekOfYear: The week of year to take the yearly backup in an ISO 8601 format.

    weeklyRetention
    string

    WeeklyRetention: The weekly retention policy for an LTR backup in an ISO 8601 format.

    yearlyRetention
    string

    YearlyRetention: The yearly retention policy for an LTR backup in an ISO 8601 format.

    Servers_Databases_BackupLongTermRetentionPolicy_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    properties
    BaseLongTermRetentionPolicyProperties_STATUS_ARM

    Properties: Resource properties.

    type
    string

    Type: Resource type.

    Servers_Databases_BackupLongTermRetentionPolicy_Spec

    (Appears on:ServersDatabasesBackupLongTermRetentionPolicy)

    Field Description
    monthlyRetention
    string

    MonthlyRetention: The monthly retention policy for an LTR backup in an ISO 8601 format.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/ServersDatabase resource

    weekOfYear
    int

    WeekOfYear: The week of year to take the yearly backup in an ISO 8601 format.

    weeklyRetention
    string

    WeeklyRetention: The weekly retention policy for an LTR backup in an ISO 8601 format.

    yearlyRetention
    string

    YearlyRetention: The yearly retention policy for an LTR backup in an ISO 8601 format.

    Servers_Databases_BackupLongTermRetentionPolicy_Spec_ARM

    Field Description
    name
    string
    properties
    BaseLongTermRetentionPolicyProperties_ARM

    Properties: Resource properties.

    Servers_Databases_BackupShortTermRetentionPolicy_STATUS

    (Appears on:ServersDatabasesBackupShortTermRetentionPolicy)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    diffBackupIntervalInHours
    BackupShortTermRetentionPolicyProperties_DiffBackupIntervalInHours_STATUS

    DiffBackupIntervalInHours: The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases.

    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    retentionDays
    int

    RetentionDays: The backup retention period in days. This is how many days Point-in-Time Restore will be supported.

    type
    string

    Type: Resource type.

    Servers_Databases_BackupShortTermRetentionPolicy_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    properties
    BackupShortTermRetentionPolicyProperties_STATUS_ARM

    Properties: Resource properties.

    type
    string

    Type: Resource type.

    Servers_Databases_BackupShortTermRetentionPolicy_Spec

    (Appears on:ServersDatabasesBackupShortTermRetentionPolicy)

    Field Description
    diffBackupIntervalInHours
    BackupShortTermRetentionPolicyProperties_DiffBackupIntervalInHours

    DiffBackupIntervalInHours: The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/ServersDatabase resource

    retentionDays
    int

    RetentionDays: The backup retention period in days. This is how many days Point-in-Time Restore will be supported.

    Servers_Databases_BackupShortTermRetentionPolicy_Spec_ARM

    Field Description
    name
    string
    properties
    BackupShortTermRetentionPolicyProperties_ARM

    Properties: Resource properties.

    Servers_Databases_SecurityAlertPolicy_STATUS

    (Appears on:ServersDatabasesSecurityAlertPolicy)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    creationTime
    string

    CreationTime: Specifies the UTC creation time of the policy.

    disabledAlerts
    []string

    DisabledAlerts: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force

    emailAccountAdmins
    bool

    EmailAccountAdmins: Specifies that the alert is sent to the account administrators.

    emailAddresses
    []string

    EmailAddresses: Specifies an array of e-mail addresses to which the alert is sent.

    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    retentionDays
    int

    RetentionDays: Specifies the number of days to keep in the Threat Detection audit logs.

    state
    DatabaseSecurityAlertPoliciesSecurityAlertsPolicyProperties_State_STATUS

    State: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.

    storageEndpoint
    string

    StorageEndpoint: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

    systemData
    SystemData_STATUS

    SystemData: SystemData of SecurityAlertPolicyResource.

    type
    string

    Type: Resource type.

    Servers_Databases_SecurityAlertPolicy_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    properties
    DatabaseSecurityAlertPoliciesSecurityAlertsPolicyProperties_STATUS_ARM

    Properties: Resource properties.

    systemData
    SystemData_STATUS_ARM

    SystemData: SystemData of SecurityAlertPolicyResource.

    type
    string

    Type: Resource type.

    Servers_Databases_SecurityAlertPolicy_Spec

    (Appears on:ServersDatabasesSecurityAlertPolicy)

    Field Description
    disabledAlerts
    []string

    DisabledAlerts: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force

    emailAccountAdmins
    bool

    EmailAccountAdmins: Specifies that the alert is sent to the account administrators.

    emailAddresses
    []string

    EmailAddresses: Specifies an array of e-mail addresses to which the alert is sent.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/ServersDatabase resource

    retentionDays
    int

    RetentionDays: Specifies the number of days to keep in the Threat Detection audit logs.

    state
    DatabaseSecurityAlertPoliciesSecurityAlertsPolicyProperties_State

    State: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.

    storageAccountAccessKey
    genruntime.SecretReference

    StorageAccountAccessKey: Specifies the identifier key of the Threat Detection audit storage account.

    storageEndpoint
    string

    StorageEndpoint: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

    Servers_Databases_SecurityAlertPolicy_Spec_ARM

    Field Description
    name
    string
    properties
    DatabaseSecurityAlertPoliciesSecurityAlertsPolicyProperties_ARM

    Properties: Resource properties.

    Servers_Databases_TransparentDataEncryption_STATUS

    (Appears on:ServersDatabasesTransparentDataEncryption)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    state
    TransparentDataEncryptionProperties_State_STATUS

    State: Specifies the state of the transparent data encryption.

    type
    string

    Type: Resource type.

    Servers_Databases_TransparentDataEncryption_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    properties
    TransparentDataEncryptionProperties_STATUS_ARM

    Properties: Resource properties.

    type
    string

    Type: Resource type.

    Servers_Databases_TransparentDataEncryption_Spec

    (Appears on:ServersDatabasesTransparentDataEncryption)

    Field Description
    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/ServersDatabase resource

    state
    TransparentDataEncryptionProperties_State

    State: Specifies the state of the transparent data encryption.

    Servers_Databases_TransparentDataEncryption_Spec_ARM

    Field Description
    name
    string
    properties
    TransparentDataEncryptionProperties_ARM

    Properties: Resource properties.

    Servers_Databases_VulnerabilityAssessment_STATUS

    (Appears on:ServersDatabasesVulnerabilityAssessment)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    recurringScans
    VulnerabilityAssessmentRecurringScansProperties_STATUS

    RecurringScans: The recurring scans settings

    storageContainerPath
    string

    StorageContainerPath: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn’t set

    type
    string

    Type: Resource type.

    Servers_Databases_VulnerabilityAssessment_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    properties
    DatabaseVulnerabilityAssessmentsDatabaseVulnerabilityAssessmentProperties_STATUS_ARM

    Properties: Resource properties.

    type
    string

    Type: Resource type.

    Servers_Databases_VulnerabilityAssessment_Spec

    (Appears on:ServersDatabasesVulnerabilityAssessment)

    Field Description
    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/ServersDatabase resource

    recurringScans
    VulnerabilityAssessmentRecurringScansProperties

    RecurringScans: The recurring scans settings

    storageAccountAccessKey
    genruntime.SecretReference

    StorageAccountAccessKey: Specifies the identifier key of the storage account for vulnerability assessment scan results. If ‘StorageContainerSasKey’ isn’t specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall

    storageContainerPath
    string

    StorageContainerPath: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn’t set

    storageContainerPathFromConfig
    genruntime.ConfigMapReference

    StorageContainerPathFromConfig: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn’t set

    storageContainerSasKey
    genruntime.SecretReference

    StorageContainerSasKey: A shared access signature (SAS Key) that has write access to the blob container specified in ‘storageContainerPath’ parameter. If ‘storageAccountAccessKey’ isn’t specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall

    Servers_Databases_VulnerabilityAssessment_Spec_ARM

    Field Description
    name
    string
    properties
    DatabaseVulnerabilityAssessmentsDatabaseVulnerabilityAssessmentProperties_ARM

    Properties: Resource properties.

    Servers_ElasticPool_STATUS

    (Appears on:ServersElasticPool)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    creationDate
    string

    CreationDate: The creation date of the elastic pool (ISO8601 format).

    highAvailabilityReplicaCount
    int

    HighAvailabilityReplicaCount: The number of secondary replicas associated with the elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.

    id
    string

    Id: Resource ID.

    kind
    string

    Kind: Kind of elastic pool. This is metadata used for the Azure portal experience.

    licenseType
    ElasticPoolProperties_LicenseType_STATUS

    LicenseType: The license type to apply for this elastic pool.

    location
    string

    Location: Resource location.

    maintenanceConfigurationId
    string

    MaintenanceConfigurationId: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.

    maxSizeBytes
    int

    MaxSizeBytes: The storage limit for the database elastic pool in bytes.

    minCapacity
    float64

    MinCapacity: Minimal capacity that serverless pool will not shrink below, if not paused

    name
    string

    Name: Resource name.

    perDatabaseSettings
    ElasticPoolPerDatabaseSettings_STATUS

    PerDatabaseSettings: The per database settings for the elastic pool.

    sku
    Sku_STATUS

    Sku: The elastic pool SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or the following command: azurecli az sql elastic-pool list-editions -l <location> -o table `

    state
    ElasticPoolProperties_State_STATUS

    State: The state of the elastic pool.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    zoneRedundant
    bool

    ZoneRedundant: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.

    Servers_ElasticPool_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    kind
    string

    Kind: Kind of elastic pool. This is metadata used for the Azure portal experience.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    properties
    ElasticPoolProperties_STATUS_ARM

    Properties: Resource properties.

    sku
    Sku_STATUS_ARM

    Sku: The elastic pool SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or the following command: azurecli az sql elastic-pool list-editions -l <location> -o table `

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    Servers_ElasticPool_Spec

    (Appears on:ServersElasticPool)

    Field Description
    azureName
    string

    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.

    highAvailabilityReplicaCount
    int

    HighAvailabilityReplicaCount: The number of secondary replicas associated with the elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.

    licenseType
    ElasticPoolProperties_LicenseType

    LicenseType: The license type to apply for this elastic pool.

    location
    string

    Location: Resource location.

    maintenanceConfigurationId
    string

    MaintenanceConfigurationId: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.

    maxSizeBytes
    int

    MaxSizeBytes: The storage limit for the database elastic pool in bytes.

    minCapacity
    float64

    MinCapacity: Minimal capacity that serverless pool will not shrink below, if not paused

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    perDatabaseSettings
    ElasticPoolPerDatabaseSettings

    PerDatabaseSettings: The per database settings for the elastic pool.

    sku
    Sku

    Sku: The elastic pool SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or the following command: azurecli az sql elastic-pool list-editions -l <location> -o table `

    tags
    map[string]string

    Tags: Resource tags.

    zoneRedundant
    bool

    ZoneRedundant: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.

    Servers_ElasticPool_Spec_ARM

    Field Description
    location
    string

    Location: Resource location.

    name
    string
    properties
    ElasticPoolProperties_ARM

    Properties: Resource properties.

    sku
    Sku_ARM

    Sku: The elastic pool SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or the following command: azurecli az sql elastic-pool list-editions -l <location> -o table `

    tags
    map[string]string

    Tags: Resource tags.

    Servers_FailoverGroup_STATUS

    (Appears on:ServersFailoverGroup)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    databases
    []string

    Databases: List of databases in the failover group.

    id
    string

    Id: Resource ID.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    partnerServers
    []PartnerInfo_STATUS

    PartnerServers: List of partner server information for the failover group.

    readOnlyEndpoint
    FailoverGroupReadOnlyEndpoint_STATUS

    ReadOnlyEndpoint: Read-only endpoint of the failover group instance.

    readWriteEndpoint
    FailoverGroupReadWriteEndpoint_STATUS

    ReadWriteEndpoint: Read-write endpoint of the failover group instance.

    replicationRole
    FailoverGroupProperties_ReplicationRole_STATUS

    ReplicationRole: Local replication role of the failover group instance.

    replicationState
    string

    ReplicationState: Replication state of the failover group instance.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    Servers_FailoverGroup_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    properties
    FailoverGroupProperties_STATUS_ARM

    Properties: Resource properties.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    Servers_FailoverGroup_Spec

    (Appears on:ServersFailoverGroup)

    Field Description
    azureName
    string

    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.

    databasesReferences
    []genruntime.ResourceReference

    DatabasesReferences: List of databases in the failover group.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    partnerServers
    []PartnerInfo

    PartnerServers: List of partner server information for the failover group.

    readOnlyEndpoint
    FailoverGroupReadOnlyEndpoint

    ReadOnlyEndpoint: Read-only endpoint of the failover group instance.

    readWriteEndpoint
    FailoverGroupReadWriteEndpoint

    ReadWriteEndpoint: Read-write endpoint of the failover group instance.

    tags
    map[string]string

    Tags: Resource tags.

    Servers_FailoverGroup_Spec_ARM

    Field Description
    name
    string
    properties
    FailoverGroupProperties_ARM

    Properties: Resource properties.

    tags
    map[string]string

    Tags: Resource tags.

    Servers_FirewallRule_STATUS

    (Appears on:ServersFirewallRule)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    endIpAddress
    string

    EndIpAddress: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value ‘0.0.0.0’ for all Azure-internal IP addresses.

    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    startIpAddress
    string

    StartIpAddress: The start IP address of the firewall rule. Must be IPv4 format. Use value ‘0.0.0.0’ for all Azure-internal IP addresses.

    type
    string

    Type: Resource type.

    Servers_FirewallRule_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    properties
    ServerFirewallRuleProperties_STATUS_ARM

    Properties: Resource properties.

    type
    string

    Type: Resource type.

    Servers_FirewallRule_Spec

    (Appears on:ServersFirewallRule)

    Field Description
    azureName
    string

    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.

    endIpAddress
    string

    EndIpAddress: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value ‘0.0.0.0’ for all Azure-internal IP addresses.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    startIpAddress
    string

    StartIpAddress: The start IP address of the firewall rule. Must be IPv4 format. Use value ‘0.0.0.0’ for all Azure-internal IP addresses.

    Servers_FirewallRule_Spec_ARM

    Field Description
    name
    string

    Name: Resource name.

    properties
    ServerFirewallRuleProperties_ARM

    Properties: Resource properties.

    Servers_Ipv6FirewallRule_STATUS

    (Appears on:ServersIPV6FirewallRule)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    endIPv6Address
    string

    EndIPv6Address: The end IP address of the firewall rule. Must be IPv6 format. Must be greater than or equal to startIpAddress.

    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    startIPv6Address
    string

    StartIPv6Address: The start IP address of the firewall rule. Must be IPv6 format.

    type
    string

    Type: Resource type.

    Servers_Ipv6FirewallRule_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    properties
    IPv6ServerFirewallRuleProperties_STATUS_ARM

    Properties: Resource properties.

    type
    string

    Type: Resource type.

    Servers_Ipv6FirewallRule_Spec

    (Appears on:ServersIPV6FirewallRule)

    Field Description
    azureName
    string

    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.

    endIPv6Address
    string

    EndIPv6Address: The end IP address of the firewall rule. Must be IPv6 format. Must be greater than or equal to startIpAddress.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    startIPv6Address
    string

    StartIPv6Address: The start IP address of the firewall rule. Must be IPv6 format.

    Servers_Ipv6FirewallRule_Spec_ARM

    Field Description
    name
    string

    Name: Resource name.

    properties
    IPv6ServerFirewallRuleProperties_ARM

    Properties: Resource properties.

    Servers_OutboundFirewallRule_STATUS

    (Appears on:ServersOutboundFirewallRule)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    provisioningState
    string

    ProvisioningState: The state of the outbound rule.

    type
    string

    Type: Resource type.

    Servers_OutboundFirewallRule_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    properties
    OutboundFirewallRuleProperties_STATUS_ARM

    Properties: Resource properties.

    type
    string

    Type: Resource type.

    Servers_OutboundFirewallRule_Spec

    (Appears on:ServersOutboundFirewallRule)

    Field Description
    azureName
    string

    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.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    Servers_OutboundFirewallRule_Spec_ARM

    Field Description
    name
    string

    Servers_SecurityAlertPolicy_STATUS

    (Appears on:ServersSecurityAlertPolicy)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    creationTime
    string

    CreationTime: Specifies the UTC creation time of the policy.

    disabledAlerts
    []string

    DisabledAlerts: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force

    emailAccountAdmins
    bool

    EmailAccountAdmins: Specifies that the alert is sent to the account administrators.

    emailAddresses
    []string

    EmailAddresses: Specifies an array of e-mail addresses to which the alert is sent.

    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    retentionDays
    int

    RetentionDays: Specifies the number of days to keep in the Threat Detection audit logs.

    state
    ServerSecurityAlertPoliciesSecurityAlertsPolicyProperties_State_STATUS

    State: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.

    storageEndpoint
    string

    StorageEndpoint: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

    systemData
    SystemData_STATUS

    SystemData: SystemData of SecurityAlertPolicyResource.

    type
    string

    Type: Resource type.

    Servers_SecurityAlertPolicy_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    properties
    ServerSecurityAlertPoliciesSecurityAlertsPolicyProperties_STATUS_ARM

    Properties: Resource properties.

    systemData
    SystemData_STATUS_ARM

    SystemData: SystemData of SecurityAlertPolicyResource.

    type
    string

    Type: Resource type.

    Servers_SecurityAlertPolicy_Spec

    (Appears on:ServersSecurityAlertPolicy)

    Field Description
    disabledAlerts
    []string

    DisabledAlerts: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force

    emailAccountAdmins
    bool

    EmailAccountAdmins: Specifies that the alert is sent to the account administrators.

    emailAddresses
    []string

    EmailAddresses: Specifies an array of e-mail addresses to which the alert is sent.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    retentionDays
    int

    RetentionDays: Specifies the number of days to keep in the Threat Detection audit logs.

    state
    ServerSecurityAlertPoliciesSecurityAlertsPolicyProperties_State

    State: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.

    storageAccountAccessKey
    genruntime.SecretReference

    StorageAccountAccessKey: Specifies the identifier key of the Threat Detection audit storage account.

    storageEndpoint
    string

    StorageEndpoint: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

    Servers_SecurityAlertPolicy_Spec_ARM

    Field Description
    name
    string
    properties
    ServerSecurityAlertPoliciesSecurityAlertsPolicyProperties_ARM

    Properties: Resource properties.

    Servers_VirtualNetworkRule_STATUS

    (Appears on:ServersVirtualNetworkRule)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    id
    string

    Id: Resource ID.

    ignoreMissingVnetServiceEndpoint
    bool

    IgnoreMissingVnetServiceEndpoint: Create firewall rule before the virtual network has vnet service endpoint enabled.

    name
    string

    Name: Resource name.

    state
    VirtualNetworkRuleProperties_State_STATUS

    State: Virtual Network Rule State

    type
    string

    Type: Resource type.

    virtualNetworkSubnetId
    string

    VirtualNetworkSubnetId: The ARM resource id of the virtual network subnet.

    Servers_VirtualNetworkRule_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    properties
    VirtualNetworkRuleProperties_STATUS_ARM

    Properties: Resource properties.

    type
    string

    Type: Resource type.

    Servers_VirtualNetworkRule_Spec

    (Appears on:ServersVirtualNetworkRule)

    Field Description
    azureName
    string

    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.

    ignoreMissingVnetServiceEndpoint
    bool

    IgnoreMissingVnetServiceEndpoint: Create firewall rule before the virtual network has vnet service endpoint enabled.

    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    virtualNetworkSubnetReference
    genruntime.ResourceReference

    VirtualNetworkSubnetReference: The ARM resource id of the virtual network subnet.

    Servers_VirtualNetworkRule_Spec_ARM

    Field Description
    name
    string
    properties
    VirtualNetworkRuleProperties_ARM

    Properties: Resource properties.

    Servers_VulnerabilityAssessment_STATUS

    (Appears on:ServersVulnerabilityAssessment)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    recurringScans
    VulnerabilityAssessmentRecurringScansProperties_STATUS

    RecurringScans: The recurring scans settings

    storageContainerPath
    string

    StorageContainerPath: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).

    type
    string

    Type: Resource type.

    Servers_VulnerabilityAssessment_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    name
    string

    Name: Resource name.

    properties
    ServerVulnerabilityAssessmentProperties_STATUS_ARM

    Properties: Resource properties.

    type
    string

    Type: Resource type.

    Servers_VulnerabilityAssessment_Spec

    (Appears on:ServersVulnerabilityAssessment)

    Field Description
    owner
    genruntime.KnownResourceReference

    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 sql.azure.com/Server resource

    recurringScans
    VulnerabilityAssessmentRecurringScansProperties

    RecurringScans: The recurring scans settings

    storageAccountAccessKey
    genruntime.SecretReference

    StorageAccountAccessKey: Specifies the identifier key of the storage account for vulnerability assessment scan results. If ‘StorageContainerSasKey’ isn’t specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall

    storageContainerPath
    string

    StorageContainerPath: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).

    storageContainerPathFromConfig
    genruntime.ConfigMapReference

    StorageContainerPathFromConfig: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).

    storageContainerSasKey
    genruntime.SecretReference

    StorageContainerSasKey: A shared access signature (SAS Key) that has write access to the blob container specified in ‘storageContainerPath’ parameter. If ‘storageAccountAccessKey’ isn’t specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall

    Servers_VulnerabilityAssessment_Spec_ARM

    Field Description
    name
    string
    properties
    ServerVulnerabilityAssessmentProperties_ARM

    Properties: Resource properties.

    Sku

    (Appears on:Servers_Database_Spec, Servers_ElasticPool_Spec)

    An ARM Resource SKU.

    Field Description
    capacity
    int

    Capacity: Capacity of the particular SKU.

    family
    string

    Family: If the service has different generations of hardware, for the same SKU, then that can be captured here.

    name
    string

    Name: The name of the SKU, typically, a letter + Number code, e.g. P3.

    size
    string

    Size: Size of the particular SKU

    tier
    string

    Tier: The tier or edition of the particular SKU, e.g. Basic, Premium.

    Sku_ARM

    (Appears on:Servers_Database_Spec_ARM, Servers_ElasticPool_Spec_ARM)

    An ARM Resource SKU.

    Field Description
    capacity
    int

    Capacity: Capacity of the particular SKU.

    family
    string

    Family: If the service has different generations of hardware, for the same SKU, then that can be captured here.

    name
    string

    Name: The name of the SKU, typically, a letter + Number code, e.g. P3.

    size
    string

    Size: Size of the particular SKU

    tier
    string

    Tier: The tier or edition of the particular SKU, e.g. Basic, Premium.

    Sku_STATUS

    (Appears on:Servers_Database_STATUS, Servers_ElasticPool_STATUS)

    An ARM Resource SKU.

    Field Description
    capacity
    int

    Capacity: Capacity of the particular SKU.

    family
    string

    Family: If the service has different generations of hardware, for the same SKU, then that can be captured here.

    name
    string

    Name: The name of the SKU, typically, a letter + Number code, e.g. P3.

    size
    string

    Size: Size of the particular SKU

    tier
    string

    Tier: The tier or edition of the particular SKU, e.g. Basic, Premium.

    Sku_STATUS_ARM

    (Appears on:DatabaseProperties_STATUS_ARM, Servers_Database_STATUS_ARM, Servers_ElasticPool_STATUS_ARM)

    An ARM Resource SKU.

    Field Description
    capacity
    int

    Capacity: Capacity of the particular SKU.

    family
    string

    Family: If the service has different generations of hardware, for the same SKU, then that can be captured here.

    name
    string

    Name: The name of the SKU, typically, a letter + Number code, e.g. P3.

    size
    string

    Size: Size of the particular SKU

    tier
    string

    Tier: The tier or edition of the particular SKU, e.g. Basic, Premium.

    SystemData_CreatedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_CreatedByType_STATUS_ARM (string alias)

    (Appears on:SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS_ARM (string alias)

    (Appears on:SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_STATUS

    (Appears on:Servers_AdvancedThreatProtectionSetting_STATUS, Servers_Databases_AdvancedThreatProtectionSetting_STATUS, Servers_Databases_SecurityAlertPolicy_STATUS, Servers_SecurityAlertPolicy_STATUS)

    Metadata pertaining to creation and last modification of the resource.

    Field Description
    createdAt
    string

    CreatedAt: The timestamp of resource creation (UTC).

    createdBy
    string

    CreatedBy: The identity that created the resource.

    createdByType
    SystemData_CreatedByType_STATUS

    CreatedByType: The type of identity that created the resource.

    lastModifiedAt
    string

    LastModifiedAt: The timestamp of resource last modification (UTC)

    lastModifiedBy
    string

    LastModifiedBy: The identity that last modified the resource.

    lastModifiedByType
    SystemData_LastModifiedByType_STATUS

    LastModifiedByType: The type of identity that last modified the resource.

    SystemData_STATUS_ARM

    (Appears on:Servers_AdvancedThreatProtectionSetting_STATUS_ARM, Servers_Databases_AdvancedThreatProtectionSetting_STATUS_ARM, Servers_Databases_SecurityAlertPolicy_STATUS_ARM, Servers_SecurityAlertPolicy_STATUS_ARM)

    Metadata pertaining to creation and last modification of the resource.

    Field Description
    createdAt
    string

    CreatedAt: The timestamp of resource creation (UTC).

    createdBy
    string

    CreatedBy: The identity that created the resource.

    createdByType
    SystemData_CreatedByType_STATUS_ARM

    CreatedByType: The type of identity that created the resource.

    lastModifiedAt
    string

    LastModifiedAt: The timestamp of resource last modification (UTC)

    lastModifiedBy
    string

    LastModifiedBy: The identity that last modified the resource.

    lastModifiedByType
    SystemData_LastModifiedByType_STATUS_ARM

    LastModifiedByType: The type of identity that last modified the resource.

    TransparentDataEncryptionProperties_ARM

    (Appears on:Servers_Databases_TransparentDataEncryption_Spec_ARM)

    Properties of a transparent data encryption.

    Field Description
    state
    TransparentDataEncryptionProperties_State_ARM

    State: Specifies the state of the transparent data encryption.

    TransparentDataEncryptionProperties_STATUS_ARM

    (Appears on:Servers_Databases_TransparentDataEncryption_STATUS_ARM)

    Properties of a transparent data encryption.

    Field Description
    state
    TransparentDataEncryptionProperties_State_STATUS_ARM

    State: Specifies the state of the transparent data encryption.

    TransparentDataEncryptionProperties_State (string alias)

    (Appears on:Servers_Databases_TransparentDataEncryption_Spec)

    Value Description

    "Disabled"

    "Enabled"

    TransparentDataEncryptionProperties_State_ARM (string alias)

    (Appears on:TransparentDataEncryptionProperties_ARM)

    Value Description

    "Disabled"

    "Enabled"

    TransparentDataEncryptionProperties_State_STATUS (string alias)

    (Appears on:Servers_Databases_TransparentDataEncryption_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    TransparentDataEncryptionProperties_State_STATUS_ARM (string alias)

    (Appears on:TransparentDataEncryptionProperties_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    UserAssignedIdentityDetails

    (Appears on:DatabaseIdentity, ResourceIdentity)

    Information about the user assigned identity for the resource

    Field Description
    reference
    genruntime.ResourceReference

    UserAssignedIdentityDetails_ARM

    (Appears on:DatabaseIdentity_ARM, ResourceIdentity_ARM)

    Information about the user assigned identity for the resource

    UserIdentity_STATUS

    (Appears on:ResourceIdentity_STATUS)

    Azure Active Directory identity configuration for a resource.

    Field Description
    clientId
    string

    ClientId: The Azure Active Directory client id.

    principalId
    string

    PrincipalId: The Azure Active Directory principal id.

    UserIdentity_STATUS_ARM

    (Appears on:ResourceIdentity_STATUS_ARM)

    Azure Active Directory identity configuration for a resource.

    Field Description
    clientId
    string

    ClientId: The Azure Active Directory client id.

    principalId
    string

    PrincipalId: The Azure Active Directory principal id.

    VirtualNetworkRuleProperties_ARM

    (Appears on:Servers_VirtualNetworkRule_Spec_ARM)

    Properties of a virtual network rule.

    Field Description
    ignoreMissingVnetServiceEndpoint
    bool

    IgnoreMissingVnetServiceEndpoint: Create firewall rule before the virtual network has vnet service endpoint enabled.

    virtualNetworkSubnetId
    string

    VirtualNetworkRuleProperties_STATUS_ARM

    (Appears on:Servers_VirtualNetworkRule_STATUS_ARM)

    Properties of a virtual network rule.

    Field Description
    ignoreMissingVnetServiceEndpoint
    bool

    IgnoreMissingVnetServiceEndpoint: Create firewall rule before the virtual network has vnet service endpoint enabled.

    state
    VirtualNetworkRuleProperties_State_STATUS_ARM

    State: Virtual Network Rule State

    virtualNetworkSubnetId
    string

    VirtualNetworkSubnetId: The ARM resource id of the virtual network subnet.

    VirtualNetworkRuleProperties_State_STATUS (string alias)

    (Appears on:Servers_VirtualNetworkRule_STATUS)

    Value Description

    "Deleting"

    "Failed"

    "InProgress"

    "Initializing"

    "Ready"

    "Unknown"

    VirtualNetworkRuleProperties_State_STATUS_ARM (string alias)

    (Appears on:VirtualNetworkRuleProperties_STATUS_ARM)

    Value Description

    "Deleting"

    "Failed"

    "InProgress"

    "Initializing"

    "Ready"

    "Unknown"

    VulnerabilityAssessmentRecurringScansProperties

    (Appears on:Servers_Databases_VulnerabilityAssessment_Spec, Servers_VulnerabilityAssessment_Spec)

    Properties of a Vulnerability Assessment recurring scans.

    Field Description
    emailSubscriptionAdmins
    bool

    EmailSubscriptionAdmins: Specifies that the schedule scan notification will be is sent to the subscription administrators.

    emails
    []string

    Emails: Specifies an array of e-mail addresses to which the scan notification is sent.

    isEnabled
    bool

    IsEnabled: Recurring scans state.

    VulnerabilityAssessmentRecurringScansProperties_ARM

    (Appears on:DatabaseVulnerabilityAssessmentsDatabaseVulnerabilityAssessmentProperties_ARM, ServerVulnerabilityAssessmentProperties_ARM)

    Properties of a Vulnerability Assessment recurring scans.

    Field Description
    emailSubscriptionAdmins
    bool

    EmailSubscriptionAdmins: Specifies that the schedule scan notification will be is sent to the subscription administrators.

    emails
    []string

    Emails: Specifies an array of e-mail addresses to which the scan notification is sent.

    isEnabled
    bool

    IsEnabled: Recurring scans state.

    VulnerabilityAssessmentRecurringScansProperties_STATUS

    (Appears on:Servers_Databases_VulnerabilityAssessment_STATUS, Servers_VulnerabilityAssessment_STATUS)

    Properties of a Vulnerability Assessment recurring scans.

    Field Description
    emailSubscriptionAdmins
    bool

    EmailSubscriptionAdmins: Specifies that the schedule scan notification will be is sent to the subscription administrators.

    emails
    []string

    Emails: Specifies an array of e-mail addresses to which the scan notification is sent.

    isEnabled
    bool

    IsEnabled: Recurring scans state.

    VulnerabilityAssessmentRecurringScansProperties_STATUS_ARM

    (Appears on:DatabaseVulnerabilityAssessmentsDatabaseVulnerabilityAssessmentProperties_STATUS_ARM, ServerVulnerabilityAssessmentProperties_STATUS_ARM)

    Properties of a Vulnerability Assessment recurring scans.

    Field Description
    emailSubscriptionAdmins
    bool

    EmailSubscriptionAdmins: Specifies that the schedule scan notification will be is sent to the subscription administrators.

    emails
    []string

    Emails: Specifies an array of e-mail addresses to which the scan notification is sent.

    isEnabled
    bool

    IsEnabled: Recurring scans state.