Microsoft.AzureArcData (preview:2025-06-01)

2025/09/16 • 74 new methods

Operations_List (new)
Description :  Lists all of the available Azure Data Services on Azure Arc API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AzureArcData/operations
{
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation being performed on this particular object. ,
Required: True ,
}
string ,
display:
{
Description: The localized display information for this particular operation / action. ,
Required: True ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name. ,
Required: True ,
}
string ,
resource:
{
Description: The localized friendly form of the resource type related to this action/operation. ,
Required: True ,
}
string ,
operation:
{
Description: The localized friendly name for the operation. ,
Required: True ,
}
string ,
description:
{
Description: The localized friendly description for the operation. ,
Required: True ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation. ,
Enum:
{
user: No description available. ,
system: No description available. ,
}
,
Required: False ,
}
enum ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: True ,
}
boolean ,
properties:
{
Description: Additional descriptions for the operation. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlManagedInstances_List (new)
Description :  List sqlManagedInstance resources in the subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlManagedInstances
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: null ,
Required: True ,
}
{
dataControllerId:
{
Description: null ,
Required: False ,
}
string ,
admin:
{
Description: The instance admin user ,
Required: False ,
}
string ,
startTime:
{
Description: The instance start time ,
Required: False ,
}
string ,
endTime:
{
Description: The instance end time ,
Required: False ,
}
string ,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
{
spec:
{
Description: The kubernetes spec information. ,
Required: False ,
}
{
scheduling:
{
Description: The kubernetes scheduling information. ,
Required: False ,
}
{
default:
{
Description: The kubernetes scheduling options. It describes restrictions used to help Kubernetes select appropriate nodes to host the database service ,
Required: False ,
}
{
resources:
{
Description: The kubernetes resource limits and requests used to restrict or reserve resource usage. ,
Required: False ,
}
{
requests:
{
Description: Requests for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. ,
Required: False ,
}
object ,
limits:
{
Description: Limits for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. ,
Required: False ,
}
object ,
}
,
}
,
}
,
replicas:
{
Description: This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purposes. If sku.tier is BusinessCritical, allowed values are '2' or '3' with default of '3'. If sku.tier is GeneralPurpose, replicas must be '1'. ,
Format: int32 ,
Required: False ,
}
integer ,
security:
{
Description: The kubernetes security information. ,
Required: False ,
}
{
adminLoginSecret:
{
Description: Admin login secret key ,
Required: False ,
}
string ,
serviceCertificateSecret:
{
Description: Service certificate secret used ,
Required: False ,
}
string ,
activeDirectory:
{
Description: The kubernetes active directory information. ,
Required: False ,
}
{
connector:
{
Required: False ,
}
{
name:
{
Description: Name of the connector ,
Required: False ,
}
string ,
namespace:
{
Description: Name space of the connector ,
Required: False ,
}
string ,
}
,
accountName:
{
Description: Account name for AAD ,
Required: False ,
}
string ,
keytabSecret:
{
Description: Keytab secret used to authenticate with Active Directory. ,
Required: False ,
}
string ,
encryptionTypes:
{
Description: An array of encryption types ,
Required: False ,
}
[
string ,
]
,
}
,
transparentDataEncryption:
{
Description: Transparent data encryption information. ,
Required: False ,
}
{
mode:
{
Description: Transparent data encryption mode. Can be Service Managed, Customer managed or disabled ,
Required: False ,
}
string ,
protectorSecret:
{
Description: Protector secret for customer managed Transparent data encryption mode ,
Required: False ,
}
string ,
}
,
}
,
settings:
{
Description: The kubernetes settings information. ,
Required: False ,
}
{
network:
{
Description: The kubernetes network settings information. ,
Required: False ,
}
{
forceencryption:
{
Description: If 1, then SQL Server forces all connections to be encrypted. By default, this option is 0 ,
Format: int32 ,
Required: False ,
}
integer ,
tlsciphers:
{
Description: Specifies which ciphers are allowed by SQL Server for TLS ,
Required: False ,
}
string ,
tlsprotocols:
{
Description: A comma-separated list of which TLS protocols are allowed by SQL Server ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
basicLoginInformation:
{
Description: Username and password for basic authentication. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Managed Instance resource. ,
Required: False ,
}
string ,
activeDirectoryInformation:
{
Description: Active Directory information related to this SQL Managed Instance. ,
Required: False ,
}
{
keytabInformation:
{
Description: Keytab information that is used for the Sql Managed Instance when Active Directory authentication is used. ,
Required: False ,
}
{
keytab:
{
Description: A base64-encoded keytab. ,
Required: False ,
}
string ,
}
,
}
,
licenseType:
{
Description: The license type to apply for this managed instance. ,
Enum:
{
BasePrice: No description available. ,
LicenseIncluded: No description available. ,
DisasterRecovery: No description available. ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. ,
Required: False ,
}
string ,
extensionId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Resource sku. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
vCore: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The pricing tier for the instance. ,
Enum:
{
GeneralPurpose: No description available. ,
BusinessCritical: No description available. ,
}
,
Required: False ,
}
enum ,
dev:
{
Description: Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. ,
Required: False ,
}
boolean ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlManagedInstances_ListByResourceGroup (new)
Description :  Gets all sqlManagedInstances in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: null ,
Required: True ,
}
{
dataControllerId:
{
Description: null ,
Required: False ,
}
string ,
admin:
{
Description: The instance admin user ,
Required: False ,
}
string ,
startTime:
{
Description: The instance start time ,
Required: False ,
}
string ,
endTime:
{
Description: The instance end time ,
Required: False ,
}
string ,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
{
spec:
{
Description: The kubernetes spec information. ,
Required: False ,
}
{
scheduling:
{
Description: The kubernetes scheduling information. ,
Required: False ,
}
{
default:
{
Description: The kubernetes scheduling options. It describes restrictions used to help Kubernetes select appropriate nodes to host the database service ,
Required: False ,
}
{
resources:
{
Description: The kubernetes resource limits and requests used to restrict or reserve resource usage. ,
Required: False ,
}
{
requests:
{
Description: Requests for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. ,
Required: False ,
}
object ,
limits:
{
Description: Limits for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. ,
Required: False ,
}
object ,
}
,
}
,
}
,
replicas:
{
Description: This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purposes. If sku.tier is BusinessCritical, allowed values are '2' or '3' with default of '3'. If sku.tier is GeneralPurpose, replicas must be '1'. ,
Format: int32 ,
Required: False ,
}
integer ,
security:
{
Description: The kubernetes security information. ,
Required: False ,
}
{
adminLoginSecret:
{
Description: Admin login secret key ,
Required: False ,
}
string ,
serviceCertificateSecret:
{
Description: Service certificate secret used ,
Required: False ,
}
string ,
activeDirectory:
{
Description: The kubernetes active directory information. ,
Required: False ,
}
{
connector:
{
Required: False ,
}
{
name:
{
Description: Name of the connector ,
Required: False ,
}
string ,
namespace:
{
Description: Name space of the connector ,
Required: False ,
}
string ,
}
,
accountName:
{
Description: Account name for AAD ,
Required: False ,
}
string ,
keytabSecret:
{
Description: Keytab secret used to authenticate with Active Directory. ,
Required: False ,
}
string ,
encryptionTypes:
{
Description: An array of encryption types ,
Required: False ,
}
[
string ,
]
,
}
,
transparentDataEncryption:
{
Description: Transparent data encryption information. ,
Required: False ,
}
{
mode:
{
Description: Transparent data encryption mode. Can be Service Managed, Customer managed or disabled ,
Required: False ,
}
string ,
protectorSecret:
{
Description: Protector secret for customer managed Transparent data encryption mode ,
Required: False ,
}
string ,
}
,
}
,
settings:
{
Description: The kubernetes settings information. ,
Required: False ,
}
{
network:
{
Description: The kubernetes network settings information. ,
Required: False ,
}
{
forceencryption:
{
Description: If 1, then SQL Server forces all connections to be encrypted. By default, this option is 0 ,
Format: int32 ,
Required: False ,
}
integer ,
tlsciphers:
{
Description: Specifies which ciphers are allowed by SQL Server for TLS ,
Required: False ,
}
string ,
tlsprotocols:
{
Description: A comma-separated list of which TLS protocols are allowed by SQL Server ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
basicLoginInformation:
{
Description: Username and password for basic authentication. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Managed Instance resource. ,
Required: False ,
}
string ,
activeDirectoryInformation:
{
Description: Active Directory information related to this SQL Managed Instance. ,
Required: False ,
}
{
keytabInformation:
{
Description: Keytab information that is used for the Sql Managed Instance when Active Directory authentication is used. ,
Required: False ,
}
{
keytab:
{
Description: A base64-encoded keytab. ,
Required: False ,
}
string ,
}
,
}
,
licenseType:
{
Description: The license type to apply for this managed instance. ,
Enum:
{
BasePrice: No description available. ,
LicenseIncluded: No description available. ,
DisasterRecovery: No description available. ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. ,
Required: False ,
}
string ,
extensionId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Resource sku. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
vCore: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The pricing tier for the instance. ,
Enum:
{
GeneralPurpose: No description available. ,
BusinessCritical: No description available. ,
}
,
Required: False ,
}
enum ,
dev:
{
Description: Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. ,
Required: False ,
}
boolean ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlManagedInstances_Get (new)
Description :  Retrieves a SQL Managed Instance resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlManagedInstanceName:
{
Description: Name of SQL Managed Instance ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: null ,
Required: True ,
}
{
dataControllerId:
{
Description: null ,
Required: False ,
}
string ,
admin:
{
Description: The instance admin user ,
Required: False ,
}
string ,
startTime:
{
Description: The instance start time ,
Required: False ,
}
string ,
endTime:
{
Description: The instance end time ,
Required: False ,
}
string ,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
{
spec:
{
Description: The kubernetes spec information. ,
Required: False ,
}
{
scheduling:
{
Description: The kubernetes scheduling information. ,
Required: False ,
}
{
default:
{
Description: The kubernetes scheduling options. It describes restrictions used to help Kubernetes select appropriate nodes to host the database service ,
Required: False ,
}
{
resources:
{
Description: The kubernetes resource limits and requests used to restrict or reserve resource usage. ,
Required: False ,
}
{
requests:
{
Description: Requests for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. ,
Required: False ,
}
object ,
limits:
{
Description: Limits for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. ,
Required: False ,
}
object ,
}
,
}
,
}
,
replicas:
{
Description: This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purposes. If sku.tier is BusinessCritical, allowed values are '2' or '3' with default of '3'. If sku.tier is GeneralPurpose, replicas must be '1'. ,
Format: int32 ,
Required: False ,
}
integer ,
security:
{
Description: The kubernetes security information. ,
Required: False ,
}
{
adminLoginSecret:
{
Description: Admin login secret key ,
Required: False ,
}
string ,
serviceCertificateSecret:
{
Description: Service certificate secret used ,
Required: False ,
}
string ,
activeDirectory:
{
Description: The kubernetes active directory information. ,
Required: False ,
}
{
connector:
{
Required: False ,
}
{
name:
{
Description: Name of the connector ,
Required: False ,
}
string ,
namespace:
{
Description: Name space of the connector ,
Required: False ,
}
string ,
}
,
accountName:
{
Description: Account name for AAD ,
Required: False ,
}
string ,
keytabSecret:
{
Description: Keytab secret used to authenticate with Active Directory. ,
Required: False ,
}
string ,
encryptionTypes:
{
Description: An array of encryption types ,
Required: False ,
}
[
string ,
]
,
}
,
transparentDataEncryption:
{
Description: Transparent data encryption information. ,
Required: False ,
}
{
mode:
{
Description: Transparent data encryption mode. Can be Service Managed, Customer managed or disabled ,
Required: False ,
}
string ,
protectorSecret:
{
Description: Protector secret for customer managed Transparent data encryption mode ,
Required: False ,
}
string ,
}
,
}
,
settings:
{
Description: The kubernetes settings information. ,
Required: False ,
}
{
network:
{
Description: The kubernetes network settings information. ,
Required: False ,
}
{
forceencryption:
{
Description: If 1, then SQL Server forces all connections to be encrypted. By default, this option is 0 ,
Format: int32 ,
Required: False ,
}
integer ,
tlsciphers:
{
Description: Specifies which ciphers are allowed by SQL Server for TLS ,
Required: False ,
}
string ,
tlsprotocols:
{
Description: A comma-separated list of which TLS protocols are allowed by SQL Server ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
basicLoginInformation:
{
Description: Username and password for basic authentication. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Managed Instance resource. ,
Required: False ,
}
string ,
activeDirectoryInformation:
{
Description: Active Directory information related to this SQL Managed Instance. ,
Required: False ,
}
{
keytabInformation:
{
Description: Keytab information that is used for the Sql Managed Instance when Active Directory authentication is used. ,
Required: False ,
}
{
keytab:
{
Description: A base64-encoded keytab. ,
Required: False ,
}
string ,
}
,
}
,
licenseType:
{
Description: The license type to apply for this managed instance. ,
Enum:
{
BasePrice: No description available. ,
LicenseIncluded: No description available. ,
DisasterRecovery: No description available. ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. ,
Required: False ,
}
string ,
extensionId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Resource sku. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
vCore: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The pricing tier for the instance. ,
Enum:
{
GeneralPurpose: No description available. ,
BusinessCritical: No description available. ,
}
,
Required: False ,
}
enum ,
dev:
{
Description: Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. ,
Required: False ,
}
boolean ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlManagedInstances_Create (new)
Description :  Creates or replaces a SQL Managed Instance resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlManagedInstanceName:
{
Description: Name of SQL Managed Instance ,
Required: True ,
}
string ,
sqlManagedInstance:
{
Description: The SQL Managed Instance to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: null ,
Required: True ,
}
{
dataControllerId:
{
Description: null ,
Required: False ,
}
string ,
admin:
{
Description: The instance admin user ,
Required: False ,
}
string ,
startTime:
{
Description: The instance start time ,
Required: False ,
}
string ,
endTime:
{
Description: The instance end time ,
Required: False ,
}
string ,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
{
spec:
{
Description: The kubernetes spec information. ,
Required: False ,
}
{
scheduling:
{
Description: The kubernetes scheduling information. ,
Required: False ,
}
{
default:
{
Description: The kubernetes scheduling options. It describes restrictions used to help Kubernetes select appropriate nodes to host the database service ,
Required: False ,
}
{
resources:
{
Description: The kubernetes resource limits and requests used to restrict or reserve resource usage. ,
Required: False ,
}
{
requests:
{
Description: Requests for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. ,
Required: False ,
}
object ,
limits:
{
Description: Limits for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. ,
Required: False ,
}
object ,
}
,
}
,
}
,
replicas:
{
Description: This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purposes. If sku.tier is BusinessCritical, allowed values are '2' or '3' with default of '3'. If sku.tier is GeneralPurpose, replicas must be '1'. ,
Format: int32 ,
Required: False ,
}
integer ,
security:
{
Description: The kubernetes security information. ,
Required: False ,
}
{
adminLoginSecret:
{
Description: Admin login secret key ,
Required: False ,
}
string ,
serviceCertificateSecret:
{
Description: Service certificate secret used ,
Required: False ,
}
string ,
activeDirectory:
{
Description: The kubernetes active directory information. ,
Required: False ,
}
{
connector:
{
Required: False ,
}
{
name:
{
Description: Name of the connector ,
Required: False ,
}
string ,
namespace:
{
Description: Name space of the connector ,
Required: False ,
}
string ,
}
,
accountName:
{
Description: Account name for AAD ,
Required: False ,
}
string ,
keytabSecret:
{
Description: Keytab secret used to authenticate with Active Directory. ,
Required: False ,
}
string ,
encryptionTypes:
{
Description: An array of encryption types ,
Required: False ,
}
[
string ,
]
,
}
,
transparentDataEncryption:
{
Description: Transparent data encryption information. ,
Required: False ,
}
{
mode:
{
Description: Transparent data encryption mode. Can be Service Managed, Customer managed or disabled ,
Required: False ,
}
string ,
protectorSecret:
{
Description: Protector secret for customer managed Transparent data encryption mode ,
Required: False ,
}
string ,
}
,
}
,
settings:
{
Description: The kubernetes settings information. ,
Required: False ,
}
{
network:
{
Description: The kubernetes network settings information. ,
Required: False ,
}
{
forceencryption:
{
Description: If 1, then SQL Server forces all connections to be encrypted. By default, this option is 0 ,
Format: int32 ,
Required: False ,
}
integer ,
tlsciphers:
{
Description: Specifies which ciphers are allowed by SQL Server for TLS ,
Required: False ,
}
string ,
tlsprotocols:
{
Description: A comma-separated list of which TLS protocols are allowed by SQL Server ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
basicLoginInformation:
{
Description: Username and password for basic authentication. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Managed Instance resource. ,
Required: False ,
}
string ,
activeDirectoryInformation:
{
Description: Active Directory information related to this SQL Managed Instance. ,
Required: False ,
}
{
keytabInformation:
{
Description: Keytab information that is used for the Sql Managed Instance when Active Directory authentication is used. ,
Required: False ,
}
{
keytab:
{
Description: A base64-encoded keytab. ,
Required: False ,
}
string ,
}
,
}
,
licenseType:
{
Description: The license type to apply for this managed instance. ,
Enum:
{
BasePrice: No description available. ,
LicenseIncluded: No description available. ,
DisasterRecovery: No description available. ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. ,
Required: False ,
}
string ,
extensionId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Resource sku. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
vCore: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The pricing tier for the instance. ,
Enum:
{
GeneralPurpose: No description available. ,
BusinessCritical: No description available. ,
}
,
Required: False ,
}
enum ,
dev:
{
Description: Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. ,
Required: False ,
}
boolean ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: null ,
Required: True ,
}
{
dataControllerId:
{
Description: null ,
Required: False ,
}
string ,
admin:
{
Description: The instance admin user ,
Required: False ,
}
string ,
startTime:
{
Description: The instance start time ,
Required: False ,
}
string ,
endTime:
{
Description: The instance end time ,
Required: False ,
}
string ,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
{
spec:
{
Description: The kubernetes spec information. ,
Required: False ,
}
{
scheduling:
{
Description: The kubernetes scheduling information. ,
Required: False ,
}
{
default:
{
Description: The kubernetes scheduling options. It describes restrictions used to help Kubernetes select appropriate nodes to host the database service ,
Required: False ,
}
{
resources:
{
Description: The kubernetes resource limits and requests used to restrict or reserve resource usage. ,
Required: False ,
}
{
requests:
{
Description: Requests for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. ,
Required: False ,
}
object ,
limits:
{
Description: Limits for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. ,
Required: False ,
}
object ,
}
,
}
,
}
,
replicas:
{
Description: This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purposes. If sku.tier is BusinessCritical, allowed values are '2' or '3' with default of '3'. If sku.tier is GeneralPurpose, replicas must be '1'. ,
Format: int32 ,
Required: False ,
}
integer ,
security:
{
Description: The kubernetes security information. ,
Required: False ,
}
{
adminLoginSecret:
{
Description: Admin login secret key ,
Required: False ,
}
string ,
serviceCertificateSecret:
{
Description: Service certificate secret used ,
Required: False ,
}
string ,
activeDirectory:
{
Description: The kubernetes active directory information. ,
Required: False ,
}
{
connector:
{
Required: False ,
}
{
name:
{
Description: Name of the connector ,
Required: False ,
}
string ,
namespace:
{
Description: Name space of the connector ,
Required: False ,
}
string ,
}
,
accountName:
{
Description: Account name for AAD ,
Required: False ,
}
string ,
keytabSecret:
{
Description: Keytab secret used to authenticate with Active Directory. ,
Required: False ,
}
string ,
encryptionTypes:
{
Description: An array of encryption types ,
Required: False ,
}
[
string ,
]
,
}
,
transparentDataEncryption:
{
Description: Transparent data encryption information. ,
Required: False ,
}
{
mode:
{
Description: Transparent data encryption mode. Can be Service Managed, Customer managed or disabled ,
Required: False ,
}
string ,
protectorSecret:
{
Description: Protector secret for customer managed Transparent data encryption mode ,
Required: False ,
}
string ,
}
,
}
,
settings:
{
Description: The kubernetes settings information. ,
Required: False ,
}
{
network:
{
Description: The kubernetes network settings information. ,
Required: False ,
}
{
forceencryption:
{
Description: If 1, then SQL Server forces all connections to be encrypted. By default, this option is 0 ,
Format: int32 ,
Required: False ,
}
integer ,
tlsciphers:
{
Description: Specifies which ciphers are allowed by SQL Server for TLS ,
Required: False ,
}
string ,
tlsprotocols:
{
Description: A comma-separated list of which TLS protocols are allowed by SQL Server ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
basicLoginInformation:
{
Description: Username and password for basic authentication. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Managed Instance resource. ,
Required: False ,
}
string ,
activeDirectoryInformation:
{
Description: Active Directory information related to this SQL Managed Instance. ,
Required: False ,
}
{
keytabInformation:
{
Description: Keytab information that is used for the Sql Managed Instance when Active Directory authentication is used. ,
Required: False ,
}
{
keytab:
{
Description: A base64-encoded keytab. ,
Required: False ,
}
string ,
}
,
}
,
licenseType:
{
Description: The license type to apply for this managed instance. ,
Enum:
{
BasePrice: No description available. ,
LicenseIncluded: No description available. ,
DisasterRecovery: No description available. ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. ,
Required: False ,
}
string ,
extensionId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Resource sku. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
vCore: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The pricing tier for the instance. ,
Enum:
{
GeneralPurpose: No description available. ,
BusinessCritical: No description available. ,
}
,
Required: False ,
}
enum ,
dev:
{
Description: Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. ,
Required: False ,
}
boolean ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: null ,
Required: True ,
}
{
dataControllerId:
{
Description: null ,
Required: False ,
}
string ,
admin:
{
Description: The instance admin user ,
Required: False ,
}
string ,
startTime:
{
Description: The instance start time ,
Required: False ,
}
string ,
endTime:
{
Description: The instance end time ,
Required: False ,
}
string ,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
{
spec:
{
Description: The kubernetes spec information. ,
Required: False ,
}
{
scheduling:
{
Description: The kubernetes scheduling information. ,
Required: False ,
}
{
default:
{
Description: The kubernetes scheduling options. It describes restrictions used to help Kubernetes select appropriate nodes to host the database service ,
Required: False ,
}
{
resources:
{
Description: The kubernetes resource limits and requests used to restrict or reserve resource usage. ,
Required: False ,
}
{
requests:
{
Description: Requests for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. ,
Required: False ,
}
object ,
limits:
{
Description: Limits for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. ,
Required: False ,
}
object ,
}
,
}
,
}
,
replicas:
{
Description: This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purposes. If sku.tier is BusinessCritical, allowed values are '2' or '3' with default of '3'. If sku.tier is GeneralPurpose, replicas must be '1'. ,
Format: int32 ,
Required: False ,
}
integer ,
security:
{
Description: The kubernetes security information. ,
Required: False ,
}
{
adminLoginSecret:
{
Description: Admin login secret key ,
Required: False ,
}
string ,
serviceCertificateSecret:
{
Description: Service certificate secret used ,
Required: False ,
}
string ,
activeDirectory:
{
Description: The kubernetes active directory information. ,
Required: False ,
}
{
connector:
{
Required: False ,
}
{
name:
{
Description: Name of the connector ,
Required: False ,
}
string ,
namespace:
{
Description: Name space of the connector ,
Required: False ,
}
string ,
}
,
accountName:
{
Description: Account name for AAD ,
Required: False ,
}
string ,
keytabSecret:
{
Description: Keytab secret used to authenticate with Active Directory. ,
Required: False ,
}
string ,
encryptionTypes:
{
Description: An array of encryption types ,
Required: False ,
}
[
string ,
]
,
}
,
transparentDataEncryption:
{
Description: Transparent data encryption information. ,
Required: False ,
}
{
mode:
{
Description: Transparent data encryption mode. Can be Service Managed, Customer managed or disabled ,
Required: False ,
}
string ,
protectorSecret:
{
Description: Protector secret for customer managed Transparent data encryption mode ,
Required: False ,
}
string ,
}
,
}
,
settings:
{
Description: The kubernetes settings information. ,
Required: False ,
}
{
network:
{
Description: The kubernetes network settings information. ,
Required: False ,
}
{
forceencryption:
{
Description: If 1, then SQL Server forces all connections to be encrypted. By default, this option is 0 ,
Format: int32 ,
Required: False ,
}
integer ,
tlsciphers:
{
Description: Specifies which ciphers are allowed by SQL Server for TLS ,
Required: False ,
}
string ,
tlsprotocols:
{
Description: A comma-separated list of which TLS protocols are allowed by SQL Server ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
basicLoginInformation:
{
Description: Username and password for basic authentication. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Managed Instance resource. ,
Required: False ,
}
string ,
activeDirectoryInformation:
{
Description: Active Directory information related to this SQL Managed Instance. ,
Required: False ,
}
{
keytabInformation:
{
Description: Keytab information that is used for the Sql Managed Instance when Active Directory authentication is used. ,
Required: False ,
}
{
keytab:
{
Description: A base64-encoded keytab. ,
Required: False ,
}
string ,
}
,
}
,
licenseType:
{
Description: The license type to apply for this managed instance. ,
Enum:
{
BasePrice: No description available. ,
LicenseIncluded: No description available. ,
DisasterRecovery: No description available. ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. ,
Required: False ,
}
string ,
extensionId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Resource sku. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
vCore: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The pricing tier for the instance. ,
Enum:
{
GeneralPurpose: No description available. ,
BusinessCritical: No description available. ,
}
,
Required: False ,
}
enum ,
dev:
{
Description: Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. ,
Required: False ,
}
boolean ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlManagedInstances_Delete (new)
Description :  Deletes a SQL Managed Instance resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlManagedInstanceName:
{
Description: Name of SQL Managed Instance ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (204)

{}
SqlManagedInstances_Update (new)
Description :  Updates a SQL Managed Instance resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlManagedInstanceName:
{
Description: Name of SQL Managed Instance ,
Required: True ,
}
string ,
parameters:
{
Description: The SQL Managed Instance. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: null ,
Required: True ,
}
{
dataControllerId:
{
Description: null ,
Required: False ,
}
string ,
admin:
{
Description: The instance admin user ,
Required: False ,
}
string ,
startTime:
{
Description: The instance start time ,
Required: False ,
}
string ,
endTime:
{
Description: The instance end time ,
Required: False ,
}
string ,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
{
spec:
{
Description: The kubernetes spec information. ,
Required: False ,
}
{
scheduling:
{
Description: The kubernetes scheduling information. ,
Required: False ,
}
{
default:
{
Description: The kubernetes scheduling options. It describes restrictions used to help Kubernetes select appropriate nodes to host the database service ,
Required: False ,
}
{
resources:
{
Description: The kubernetes resource limits and requests used to restrict or reserve resource usage. ,
Required: False ,
}
{
requests:
{
Description: Requests for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. ,
Required: False ,
}
object ,
limits:
{
Description: Limits for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. ,
Required: False ,
}
object ,
}
,
}
,
}
,
replicas:
{
Description: This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purposes. If sku.tier is BusinessCritical, allowed values are '2' or '3' with default of '3'. If sku.tier is GeneralPurpose, replicas must be '1'. ,
Format: int32 ,
Required: False ,
}
integer ,
security:
{
Description: The kubernetes security information. ,
Required: False ,
}
{
adminLoginSecret:
{
Description: Admin login secret key ,
Required: False ,
}
string ,
serviceCertificateSecret:
{
Description: Service certificate secret used ,
Required: False ,
}
string ,
activeDirectory:
{
Description: The kubernetes active directory information. ,
Required: False ,
}
{
connector:
{
Required: False ,
}
{
name:
{
Description: Name of the connector ,
Required: False ,
}
string ,
namespace:
{
Description: Name space of the connector ,
Required: False ,
}
string ,
}
,
accountName:
{
Description: Account name for AAD ,
Required: False ,
}
string ,
keytabSecret:
{
Description: Keytab secret used to authenticate with Active Directory. ,
Required: False ,
}
string ,
encryptionTypes:
{
Description: An array of encryption types ,
Required: False ,
}
[
string ,
]
,
}
,
transparentDataEncryption:
{
Description: Transparent data encryption information. ,
Required: False ,
}
{
mode:
{
Description: Transparent data encryption mode. Can be Service Managed, Customer managed or disabled ,
Required: False ,
}
string ,
protectorSecret:
{
Description: Protector secret for customer managed Transparent data encryption mode ,
Required: False ,
}
string ,
}
,
}
,
settings:
{
Description: The kubernetes settings information. ,
Required: False ,
}
{
network:
{
Description: The kubernetes network settings information. ,
Required: False ,
}
{
forceencryption:
{
Description: If 1, then SQL Server forces all connections to be encrypted. By default, this option is 0 ,
Format: int32 ,
Required: False ,
}
integer ,
tlsciphers:
{
Description: Specifies which ciphers are allowed by SQL Server for TLS ,
Required: False ,
}
string ,
tlsprotocols:
{
Description: A comma-separated list of which TLS protocols are allowed by SQL Server ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
basicLoginInformation:
{
Description: Username and password for basic authentication. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Managed Instance resource. ,
Required: False ,
}
string ,
activeDirectoryInformation:
{
Description: Active Directory information related to this SQL Managed Instance. ,
Required: False ,
}
{
keytabInformation:
{
Description: Keytab information that is used for the Sql Managed Instance when Active Directory authentication is used. ,
Required: False ,
}
{
keytab:
{
Description: A base64-encoded keytab. ,
Required: False ,
}
string ,
}
,
}
,
licenseType:
{
Description: The license type to apply for this managed instance. ,
Enum:
{
BasePrice: No description available. ,
LicenseIncluded: No description available. ,
DisasterRecovery: No description available. ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. ,
Required: False ,
}
string ,
extensionId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Resource sku. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
vCore: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The pricing tier for the instance. ,
Enum:
{
GeneralPurpose: No description available. ,
BusinessCritical: No description available. ,
}
,
Required: False ,
}
enum ,
dev:
{
Description: Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. ,
Required: False ,
}
boolean ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FailoverGroups_List (new)
Description :  List the failover groups associated with the given sql managed instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}/failoverGroups
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlManagedInstanceName:
{
Description: Name of SQL Managed Instance ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of failover group results. ,
Required: False ,
}
[
{
properties:
{
Description: null ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the failover group resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
partnerManagedInstanceId:
{
Description: The resource ID of the partner SQL managed instance. ,
Required: True ,
}
string ,
spec:
{
Description: The specifications of the failover group resource. ,
Required: True ,
}
{
sharedName:
{
Description: The shared name of the failover group for this SQL managed instance. Both SQL managed instance and its partner have to use the same shared name. ,
Required: False ,
}
string ,
sourceMI:
{
Description: The name of the SQL managed instance with this failover group role. ,
Required: False ,
}
string ,
partnerMI:
{
Description: The name of the partner SQL managed instance. ,
Required: False ,
}
string ,
partnerMirroringURL:
{
Description: The mirroring endpoint URL of the partner SQL managed instance. ,
Required: False ,
}
string ,
partnerMirroringCert:
{
Description: The mirroring endpoint public certificate for the partner SQL managed instance. Only PEM format is supported. ,
Required: False ,
}
string ,
partnerSyncMode:
{
Description: The partner sync mode of the SQL managed instance. ,
Enum:
{
async: No description available. ,
sync: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: The role of the SQL managed instance in this failover group. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
force-primary-allow-data-loss: No description available. ,
force-secondary: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: The status of the failover group custom resource. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FailoverGroups_Create (new)
Description :  Creates or replaces a failover group resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}/failoverGroups/{failoverGroupName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
failoverGroupResource:
{
Description: desc ,
Required: True ,
}
{
properties:
{
Description: null ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the failover group resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
partnerManagedInstanceId:
{
Description: The resource ID of the partner SQL managed instance. ,
Required: True ,
}
string ,
spec:
{
Description: The specifications of the failover group resource. ,
Required: True ,
}
{
sharedName:
{
Description: The shared name of the failover group for this SQL managed instance. Both SQL managed instance and its partner have to use the same shared name. ,
Required: False ,
}
string ,
sourceMI:
{
Description: The name of the SQL managed instance with this failover group role. ,
Required: False ,
}
string ,
partnerMI:
{
Description: The name of the partner SQL managed instance. ,
Required: False ,
}
string ,
partnerMirroringURL:
{
Description: The mirroring endpoint URL of the partner SQL managed instance. ,
Required: False ,
}
string ,
partnerMirroringCert:
{
Description: The mirroring endpoint public certificate for the partner SQL managed instance. Only PEM format is supported. ,
Required: False ,
}
string ,
partnerSyncMode:
{
Description: The partner sync mode of the SQL managed instance. ,
Enum:
{
async: No description available. ,
sync: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: The role of the SQL managed instance in this failover group. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
force-primary-allow-data-loss: No description available. ,
force-secondary: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: The status of the failover group custom resource. ,
Required: False ,
}
object ,
}
,
}
,
sqlManagedInstanceName:
{
Description: Name of SQL Managed Instance ,
Required: True ,
}
string ,
failoverGroupName:
{
Description: The name of the Failover Group ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: null ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the failover group resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
partnerManagedInstanceId:
{
Description: The resource ID of the partner SQL managed instance. ,
Required: True ,
}
string ,
spec:
{
Description: The specifications of the failover group resource. ,
Required: True ,
}
{
sharedName:
{
Description: The shared name of the failover group for this SQL managed instance. Both SQL managed instance and its partner have to use the same shared name. ,
Required: False ,
}
string ,
sourceMI:
{
Description: The name of the SQL managed instance with this failover group role. ,
Required: False ,
}
string ,
partnerMI:
{
Description: The name of the partner SQL managed instance. ,
Required: False ,
}
string ,
partnerMirroringURL:
{
Description: The mirroring endpoint URL of the partner SQL managed instance. ,
Required: False ,
}
string ,
partnerMirroringCert:
{
Description: The mirroring endpoint public certificate for the partner SQL managed instance. Only PEM format is supported. ,
Required: False ,
}
string ,
partnerSyncMode:
{
Description: The partner sync mode of the SQL managed instance. ,
Enum:
{
async: No description available. ,
sync: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: The role of the SQL managed instance in this failover group. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
force-primary-allow-data-loss: No description available. ,
force-secondary: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: The status of the failover group custom resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: null ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the failover group resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
partnerManagedInstanceId:
{
Description: The resource ID of the partner SQL managed instance. ,
Required: True ,
}
string ,
spec:
{
Description: The specifications of the failover group resource. ,
Required: True ,
}
{
sharedName:
{
Description: The shared name of the failover group for this SQL managed instance. Both SQL managed instance and its partner have to use the same shared name. ,
Required: False ,
}
string ,
sourceMI:
{
Description: The name of the SQL managed instance with this failover group role. ,
Required: False ,
}
string ,
partnerMI:
{
Description: The name of the partner SQL managed instance. ,
Required: False ,
}
string ,
partnerMirroringURL:
{
Description: The mirroring endpoint URL of the partner SQL managed instance. ,
Required: False ,
}
string ,
partnerMirroringCert:
{
Description: The mirroring endpoint public certificate for the partner SQL managed instance. Only PEM format is supported. ,
Required: False ,
}
string ,
partnerSyncMode:
{
Description: The partner sync mode of the SQL managed instance. ,
Enum:
{
async: No description available. ,
sync: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: The role of the SQL managed instance in this failover group. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
force-primary-allow-data-loss: No description available. ,
force-secondary: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: The status of the failover group custom resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FailoverGroups_Delete (new)
Description :  Deletes a failover group resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}/failoverGroups/{failoverGroupName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlManagedInstanceName:
{
Description: Name of SQL Managed Instance ,
Required: True ,
}
string ,
failoverGroupName:
{
Description: The name of the Failover Group ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (204)

{}
FailoverGroups_Get (new)
Description :  Retrieves a failover group resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}/failoverGroups/{failoverGroupName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlManagedInstanceName:
{
Description: Name of SQL Managed Instance ,
Required: True ,
}
string ,
failoverGroupName:
{
Description: The name of the Failover Group ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: null ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the failover group resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
partnerManagedInstanceId:
{
Description: The resource ID of the partner SQL managed instance. ,
Required: True ,
}
string ,
spec:
{
Description: The specifications of the failover group resource. ,
Required: True ,
}
{
sharedName:
{
Description: The shared name of the failover group for this SQL managed instance. Both SQL managed instance and its partner have to use the same shared name. ,
Required: False ,
}
string ,
sourceMI:
{
Description: The name of the SQL managed instance with this failover group role. ,
Required: False ,
}
string ,
partnerMI:
{
Description: The name of the partner SQL managed instance. ,
Required: False ,
}
string ,
partnerMirroringURL:
{
Description: The mirroring endpoint URL of the partner SQL managed instance. ,
Required: False ,
}
string ,
partnerMirroringCert:
{
Description: The mirroring endpoint public certificate for the partner SQL managed instance. Only PEM format is supported. ,
Required: False ,
}
string ,
partnerSyncMode:
{
Description: The partner sync mode of the SQL managed instance. ,
Enum:
{
async: No description available. ,
sync: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: The role of the SQL managed instance in this failover group. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
force-primary-allow-data-loss: No description available. ,
force-secondary: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: The status of the failover group custom resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerInstances_List (new)
Description :  List sqlServerInstance resources in the subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlServerInstances
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: null ,
Required: False ,
}
{
version:
{
Description: SQL Server version. ,
Enum:
{
Unknown: No description available. ,
SQL Server 2012: No description available. ,
SQL Server 2014: No description available. ,
SQL Server 2016: No description available. ,
SQL Server 2017: No description available. ,
SQL Server 2019: No description available. ,
SQL Server 2022: No description available. ,
SQL Server 2025: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: SQL Server edition. ,
Enum:
{
Evaluation: No description available. ,
Enterprise: No description available. ,
Standard: No description available. ,
Web: No description available. ,
Developer: No description available. ,
Express: No description available. ,
Business Intelligence: No description available. ,
Standard Developer: No description available. ,
}
,
Required: False ,
}
enum ,
containerResourceId:
{
Description: ARM Resource id of the container resource (Azure Arc for Servers). ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
createTime:
{
Description: The time when the resource was created. ,
Required: False ,
}
string ,
vCore:
{
Description: The number of logical processors used by the SQL Server instance. ,
Required: False ,
}
string ,
cores:
{
Description: The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance. ,
Required: False ,
}
string ,
status:
{
Description: The cloud connectivity status. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Registered: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
patchLevel:
{
Description: SQL Server update level. ,
Required: False ,
}
string ,
collation:
{
Description: SQL Server collation. ,
Required: False ,
}
string ,
dbMasterKeyExists:
{
Description: Indicates whether database master key exists in SQL Server. ,
Required: False ,
}
boolean ,
isHadrEnabled:
{
Description: Indicates whether always On availability groups is enabled in SQL Server. ,
Required: False ,
}
boolean ,
traceFlags:
{
Description: An array of integers, where each value represents the enabled trace flags in SQL Server. ,
Required: False ,
}
[
integer ,
]
,
currentVersion:
{
Description: SQL Server current version. ,
Required: False ,
}
string ,
instanceName:
{
Description: SQL Server instance name. ,
Required: False ,
}
string ,
tcpDynamicPorts:
{
Description: Dynamic TCP ports used by SQL Server. ,
Required: False ,
}
string ,
tcpStaticPorts:
{
Description: Static TCP ports used by SQL Server. ,
Required: False ,
}
string ,
productId:
{
Description: SQL Server product ID. ,
Required: False ,
}
string ,
licenseType:
{
Description: SQL Server license type. ,
Enum:
{
Undefined: No description available. ,
Free: No description available. ,
HADR: No description available. ,
ServerCAL: No description available. ,
LicenseOnly: No description available. ,
PAYG: No description available. ,
Paid: No description available. ,
FabricCapacity: No description available. ,
}
,
Required: False ,
}
enum ,
azureDefenderStatusLastUpdated:
{
Description: Timestamp of last Azure Defender status update. ,
Format: date-time ,
Required: False ,
}
string ,
azureDefenderStatus:
{
Description: Status of Azure Defender. ,
Enum:
{
Protected: No description available. ,
Unprotected: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server resource. ,
Required: False ,
}
string ,
lastInventoryUploadTime:
{
Description: The time when last successful inventory upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUsageUploadTime:
{
Description: The time when last successful usage upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host for Azure Arc SQL Server ,
Enum:
{
Azure Virtual Machine: No description available. ,
Azure VMWare Virtual Machine: No description available. ,
Azure Kubernetes Service: No description available. ,
AWS VMWare Virtual Machine: No description available. ,
AWS Kubernetes Service: No description available. ,
GCP VMWare Virtual Machine: No description available. ,
GCP Kubernetes Service: No description available. ,
Container: No description available. ,
Virtual Machine: No description available. ,
Physical Server: No description available. ,
AWS Virtual Machine: No description available. ,
GCP Virtual Machine: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
alwaysOnRole:
{
Description: The role of the SQL Server, based on availability. ,
Enum:
{
None: No description available. ,
FailoverClusterInstance: No description available. ,
FailoverClusterNode: No description available. ,
AvailabilityGroupReplica: No description available. ,
}
,
Required: False ,
}
enum ,
databaseMirroringEndpoint:
{
Description: Database mirroring endpoint related properties. ,
Required: False ,
}
{
endpointName:
{
Description: Name of the database mirroring endpoint. ,
Required: False ,
}
string ,
role:
{
Description: Mirroring Role ,
Enum:
{
NONE: No description available. ,
PARTNER: No description available. ,
WITNESS: No description available. ,
ALL: No description available. ,
}
,
Required: False ,
}
enum ,
isEncryptionEnabled:
{
Description: Is Encryption enabled ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: Encryption Algorithm ,
Enum:
{
NONE: No description available. ,
RC4: No description available. ,
AES: No description available. ,
NONE, RC4: No description available. ,
NONE, AES: No description available. ,
RC4, AES: No description available. ,
AES, RC4: No description available. ,
NONE, RC4, AES: No description available. ,
NONE, AES, RC4: No description available. ,
}
,
Required: False ,
}
enum ,
connectionAuth:
{
Description: The type of connection authentication required for connections to this endpoint ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number that the endpoint is listening on. ,
Format: int32 ,
Required: False ,
}
integer ,
isDynamicPort:
{
Description: Is the port number dynamically assigned. ,
Required: False ,
}
boolean ,
ipAddress:
{
Description: Listener IP address. ,
Required: False ,
}
string ,
certificateName:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
certificateExpiryDate:
{
Description: The certificate expiry date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverCluster:
{
Description: Failover Cluster Instance properties. ,
Required: False ,
}
{
id:
{
Description: The GUID of the SQL Server's underlying Failover Cluster. ,
Required: False ,
}
string ,
networkName:
{
Description: The network name to connect to the SQL FCI. ,
Required: False ,
}
string ,
sqlInstanceIds:
{
Description: The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster. ,
Required: False ,
}
[
string ,
]
,
hostNames:
{
Description: The host names which are part of the SQL FCI resource group. ,
Required: False ,
}
[
string ,
]
,
hostIPAddresses:
{
Description: The IP addresses and subnet masks associated with the SQL Failover Cluster Instance on this host. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask ,
Required: False ,
}
string ,
}
,
]
,
}
,
backupPolicy:
{
Description: The backup profile for the SQL server. ,
Required: False ,
}
{
retentionPeriodDays:
{
Description: The retention period for all the databases in this managed instance. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupDays:
{
Description: The value indicating days between full backups. ,
Format: int32 ,
Required: False ,
}
integer ,
differentialBackupHours:
{
Description: The differential backup interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionLogBackupMinutes:
{
Description: The value indicating minutes between transaction log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
upgradeLockedUntil:
{
Description: Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty. ,
Format: date-time ,
Required: False ,
}
string ,
monitoring:
{
Description: The monitoring configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if monitoring is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
}
,
migration:
{
Description: Migration related configuration. ,
Required: False ,
}
{
assessment:
{
Description: Migration assessments related configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if migration assessment is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
assessmentUploadTime:
{
Description: The time when Migration Assessment Report upload was last performed. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: version of this migration assessment report - to be passed by the migration assessment engine. ,
Required: False ,
}
string ,
settings:
{
Description: Settings impacting the migration assessment computation - configurable with some default values if not set. ,
Required: False ,
}
{
targetLocation:
{
Description: The target location for Azure SQL SKU for migration. - default West US ,
Required: False ,
}
string ,
percentile:
{
Description: Indicate the percentile value for the performance sample. (Default is 95th percentile) ,
Format: float ,
Required: False ,
}
number ,
lookbackPeriodInDays:
{
Description: How far back to check the performance data - default is 30 (days). ,
Format: int32 ,
Required: False ,
}
number ,
strategy:
{
Description: Minimize cost or Migrate to PaaS. - to evaluate based on the recommended strategy ,
Required: False ,
}
string ,
currency:
{
Description: currency to calculate prices - default USD. ,
Required: False ,
}
string ,
discountPercentage:
{
Description: flat discount percentage to apply for the price - default 0 ,
Format: float ,
Required: False ,
}
number ,
costOptions:
{
Description: Selected cost option value. ,
Required: False ,
}
{
computeAndStorageCostOption:
{
Description: selected cost saving option e.g. With1YearASPAndDevTest. ,
Required: False ,
}
string ,
sqlLicenseCostOption:
{
Description: With Azure Hybrid Benefit(AHB) or not for SQL. ,
Required: False ,
}
string ,
windowsLicenseCostOption:
{
Description: With Azure Hybrid Benefit(AHB) or not for Windows. ,
Required: False ,
}
string ,
}
,
}
,
serverAssessments:
{
Description: Issues and warnings impacting the migration of SQL Server instance to particular Azure Migration Target. ,
Required: False ,
}
[
{
appliesToMigrationTargetPlatform:
{
Required: False ,
}
string ,
featureId:
{
Required: False ,
}
string ,
impactedObjects:
{
Required: False ,
}
[
{
impactDetail:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
objectType:
{
Required: False ,
}
string ,
}
,
]
,
issueCategory:
{
Required: False ,
}
string ,
moreInformation:
{
Required: False ,
}
string ,
}
,
]
,
skuRecommendationResults:
{
Description: SKU Recommendation results for Azure migration targets for SQL Server. ,
Required: False ,
}
{
azureSqlDatabase:
{
Description: SKU Recommendation results for Azure SQL Database. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: maximum storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The maximum storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The maximum throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlManagedInstance:
{
Description: SKU Recommendation results for Azure SQL Managed Instance. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: maximum storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The maximum storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The maximum throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlVirtualMachine:
{
Description: SKU Recommendation results for Azure SQL Virtual Machine. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
availableVmSkus:
{
Description: Available VM SKUs for the Azure SQL Virtual Machine. ,
Required: False ,
}
[
string ,
]
,
virtualMachineFamily:
{
Description: The virtual machine family of the target SKU. ,
Required: False ,
}
string ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
virtualMachineSize:
{
Description: size parameters for VM size. ,
Required: False ,
}
{
virtualMachineFamily:
{
Description: Virtual Machine Family, for example : standardMSFamily ,
Required: False ,
}
string ,
sizeName:
{
Description: VM Size, for example : M64ls ,
Required: False ,
}
string ,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
azureSkuName:
{
Description: Virtual Machine SKU name,: Eg : Standard_F16s. ,
Required: False ,
}
string ,
vCPUsAvailable:
{
Description: Available vCores. This can be less than the vCores in the Constrained vCPU VM Sizes. ,
Format: int32 ,
Required: False ,
}
number ,
maxNetworkInterfaces:
{
Description: maximum network interfaces. ,
Format: int32 ,
Required: False ,
}
number ,
}
,
dataDiskSizes:
{
Description: Data disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
logDiskSizes:
{
Description: Log disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
tempDbDiskSizes:
{
Description: temp db disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}
,
impactedObjectsSummary:
{
Description: Represents a summary of migration readiness issues/warnings per feature type for Azure SQL DB and SQL MI targets ,
Required: False ,
}
{
azureSqlDatabase:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
azureSqlManagedInstance:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
bestPracticesAssessment:
{
Description: The configuration related to SQL best practices assessment. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if SQL best practices assessment is enabled for the SQL Server instance. ,
Required: False ,
}
boolean ,
schedule:
{
Description: The scheduling configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether scheduling is enabled. ,
Required: False ,
}
boolean ,
cronTrigger:
{
Description: The cron trigger configuration. ,
Required: False ,
}
{
startTime:
{
Description: Indicates the start time for the trigger. The default value is the time at which the trigger was created. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone in which the trigger is scheduled. ,
Required: False ,
}
string ,
expression:
{
Description: A cron string representing a CronTab expression. A crontab expression is a very compact way to express a recurring schedule with the following format: '{minutes} {hours} {days} {months} {days-of-week}'. ,
Required: False ,
}
string ,
}
,
}
,
}
,
clientConnection:
{
Description: Client connection related configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if client connection is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
}
,
serviceType:
{
Description: Indicates if the resource represents a SQL Server engine or a SQL Server component service installed on the host. ,
Enum:
{
Engine: SQL Server Database Services. ,
SSRS: SQL Server Reporting Services. ,
SSAS: SQL Server Analysis Services. ,
SSIS: SQL Server Integration Services. ,
PBIRS: Power BI Report Server. ,
}
,
Required: False ,
}
enum ,
maxServerMemoryMB:
{
Description: maximum server memory (MB) value configured for this instance. ,
Format: int64 ,
Required: False ,
}
integer ,
isMicrosoftPkiCertTrustConfigured:
{
Description: Indicates whether Microsoft PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. ,
Required: False ,
}
boolean ,
isDigiCertPkiCertTrustConfigured:
{
Description: Indicates whether DigiCert PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. ,
Required: False ,
}
boolean ,
authentication:
{
Description: Authentication related configuration for the SQL Server Instance. ,
Required: False ,
}
{
mode:
{
Description: Mode of authentication in SqlServer. ,
Enum:
{
Mixed: Mixed mode authentication for SQL Server which includes windows and SQL Authentication. ,
Windows: Windows Authentication for SQL Server. ,
Undefined: Used for scenarios were the mode cannot be determined. ,
}
,
Required: False ,
}
enum ,
sqlServerEntraIdentity:
{
Description: Entra Authentication configuration for the SQL Server Instance. ,
Required: False ,
}
[
{
identityType:
{
Description: The method used for Entra authentication ,
Enum:
{
SystemAssignedManagedIdentity: System Assigned Managed Identity ,
UserAssignedManagedIdentity: User Assigned Managed Identity ,
}
,
Required: False ,
}
enum ,
clientId:
{
Description: The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerInstances_ListByResourceGroup (new)
Description :  Gets all sqlServerInstances in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: null ,
Required: False ,
}
{
version:
{
Description: SQL Server version. ,
Enum:
{
Unknown: No description available. ,
SQL Server 2012: No description available. ,
SQL Server 2014: No description available. ,
SQL Server 2016: No description available. ,
SQL Server 2017: No description available. ,
SQL Server 2019: No description available. ,
SQL Server 2022: No description available. ,
SQL Server 2025: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: SQL Server edition. ,
Enum:
{
Evaluation: No description available. ,
Enterprise: No description available. ,
Standard: No description available. ,
Web: No description available. ,
Developer: No description available. ,
Express: No description available. ,
Business Intelligence: No description available. ,
Standard Developer: No description available. ,
}
,
Required: False ,
}
enum ,
containerResourceId:
{
Description: ARM Resource id of the container resource (Azure Arc for Servers). ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
createTime:
{
Description: The time when the resource was created. ,
Required: False ,
}
string ,
vCore:
{
Description: The number of logical processors used by the SQL Server instance. ,
Required: False ,
}
string ,
cores:
{
Description: The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance. ,
Required: False ,
}
string ,
status:
{
Description: The cloud connectivity status. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Registered: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
patchLevel:
{
Description: SQL Server update level. ,
Required: False ,
}
string ,
collation:
{
Description: SQL Server collation. ,
Required: False ,
}
string ,
dbMasterKeyExists:
{
Description: Indicates whether database master key exists in SQL Server. ,
Required: False ,
}
boolean ,
isHadrEnabled:
{
Description: Indicates whether always On availability groups is enabled in SQL Server. ,
Required: False ,
}
boolean ,
traceFlags:
{
Description: An array of integers, where each value represents the enabled trace flags in SQL Server. ,
Required: False ,
}
[
integer ,
]
,
currentVersion:
{
Description: SQL Server current version. ,
Required: False ,
}
string ,
instanceName:
{
Description: SQL Server instance name. ,
Required: False ,
}
string ,
tcpDynamicPorts:
{
Description: Dynamic TCP ports used by SQL Server. ,
Required: False ,
}
string ,
tcpStaticPorts:
{
Description: Static TCP ports used by SQL Server. ,
Required: False ,
}
string ,
productId:
{
Description: SQL Server product ID. ,
Required: False ,
}
string ,
licenseType:
{
Description: SQL Server license type. ,
Enum:
{
Undefined: No description available. ,
Free: No description available. ,
HADR: No description available. ,
ServerCAL: No description available. ,
LicenseOnly: No description available. ,
PAYG: No description available. ,
Paid: No description available. ,
FabricCapacity: No description available. ,
}
,
Required: False ,
}
enum ,
azureDefenderStatusLastUpdated:
{
Description: Timestamp of last Azure Defender status update. ,
Format: date-time ,
Required: False ,
}
string ,
azureDefenderStatus:
{
Description: Status of Azure Defender. ,
Enum:
{
Protected: No description available. ,
Unprotected: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server resource. ,
Required: False ,
}
string ,
lastInventoryUploadTime:
{
Description: The time when last successful inventory upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUsageUploadTime:
{
Description: The time when last successful usage upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host for Azure Arc SQL Server ,
Enum:
{
Azure Virtual Machine: No description available. ,
Azure VMWare Virtual Machine: No description available. ,
Azure Kubernetes Service: No description available. ,
AWS VMWare Virtual Machine: No description available. ,
AWS Kubernetes Service: No description available. ,
GCP VMWare Virtual Machine: No description available. ,
GCP Kubernetes Service: No description available. ,
Container: No description available. ,
Virtual Machine: No description available. ,
Physical Server: No description available. ,
AWS Virtual Machine: No description available. ,
GCP Virtual Machine: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
alwaysOnRole:
{
Description: The role of the SQL Server, based on availability. ,
Enum:
{
None: No description available. ,
FailoverClusterInstance: No description available. ,
FailoverClusterNode: No description available. ,
AvailabilityGroupReplica: No description available. ,
}
,
Required: False ,
}
enum ,
databaseMirroringEndpoint:
{
Description: Database mirroring endpoint related properties. ,
Required: False ,
}
{
endpointName:
{
Description: Name of the database mirroring endpoint. ,
Required: False ,
}
string ,
role:
{
Description: Mirroring Role ,
Enum:
{
NONE: No description available. ,
PARTNER: No description available. ,
WITNESS: No description available. ,
ALL: No description available. ,
}
,
Required: False ,
}
enum ,
isEncryptionEnabled:
{
Description: Is Encryption enabled ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: Encryption Algorithm ,
Enum:
{
NONE: No description available. ,
RC4: No description available. ,
AES: No description available. ,
NONE, RC4: No description available. ,
NONE, AES: No description available. ,
RC4, AES: No description available. ,
AES, RC4: No description available. ,
NONE, RC4, AES: No description available. ,
NONE, AES, RC4: No description available. ,
}
,
Required: False ,
}
enum ,
connectionAuth:
{
Description: The type of connection authentication required for connections to this endpoint ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number that the endpoint is listening on. ,
Format: int32 ,
Required: False ,
}
integer ,
isDynamicPort:
{
Description: Is the port number dynamically assigned. ,
Required: False ,
}
boolean ,
ipAddress:
{
Description: Listener IP address. ,
Required: False ,
}
string ,
certificateName:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
certificateExpiryDate:
{
Description: The certificate expiry date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverCluster:
{
Description: Failover Cluster Instance properties. ,
Required: False ,
}
{
id:
{
Description: The GUID of the SQL Server's underlying Failover Cluster. ,
Required: False ,
}
string ,
networkName:
{
Description: The network name to connect to the SQL FCI. ,
Required: False ,
}
string ,
sqlInstanceIds:
{
Description: The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster. ,
Required: False ,
}
[
string ,
]
,
hostNames:
{
Description: The host names which are part of the SQL FCI resource group. ,
Required: False ,
}
[
string ,
]
,
hostIPAddresses:
{
Description: The IP addresses and subnet masks associated with the SQL Failover Cluster Instance on this host. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask ,
Required: False ,
}
string ,
}
,
]
,
}
,
backupPolicy:
{
Description: The backup profile for the SQL server. ,
Required: False ,
}
{
retentionPeriodDays:
{
Description: The retention period for all the databases in this managed instance. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupDays:
{
Description: The value indicating days between full backups. ,
Format: int32 ,
Required: False ,
}
integer ,
differentialBackupHours:
{
Description: The differential backup interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionLogBackupMinutes:
{
Description: The value indicating minutes between transaction log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
upgradeLockedUntil:
{
Description: Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty. ,
Format: date-time ,
Required: False ,
}
string ,
monitoring:
{
Description: The monitoring configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if monitoring is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
}
,
migration:
{
Description: Migration related configuration. ,
Required: False ,
}
{
assessment:
{
Description: Migration assessments related configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if migration assessment is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
assessmentUploadTime:
{
Description: The time when Migration Assessment Report upload was last performed. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: version of this migration assessment report - to be passed by the migration assessment engine. ,
Required: False ,
}
string ,
settings:
{
Description: Settings impacting the migration assessment computation - configurable with some default values if not set. ,
Required: False ,
}
{
targetLocation:
{
Description: The target location for Azure SQL SKU for migration. - default West US ,
Required: False ,
}
string ,
percentile:
{
Description: Indicate the percentile value for the performance sample. (Default is 95th percentile) ,
Format: float ,
Required: False ,
}
number ,
lookbackPeriodInDays:
{
Description: How far back to check the performance data - default is 30 (days). ,
Format: int32 ,
Required: False ,
}
number ,
strategy:
{
Description: Minimize cost or Migrate to PaaS. - to evaluate based on the recommended strategy ,
Required: False ,
}
string ,
currency:
{
Description: currency to calculate prices - default USD. ,
Required: False ,
}
string ,
discountPercentage:
{
Description: flat discount percentage to apply for the price - default 0 ,
Format: float ,
Required: False ,
}
number ,
costOptions:
{
Description: Selected cost option value. ,
Required: False ,
}
{
computeAndStorageCostOption:
{
Description: selected cost saving option e.g. With1YearASPAndDevTest. ,
Required: False ,
}
string ,
sqlLicenseCostOption:
{
Description: With Azure Hybrid Benefit(AHB) or not for SQL. ,
Required: False ,
}
string ,
windowsLicenseCostOption:
{
Description: With Azure Hybrid Benefit(AHB) or not for Windows. ,
Required: False ,
}
string ,
}
,
}
,
serverAssessments:
{
Description: Issues and warnings impacting the migration of SQL Server instance to particular Azure Migration Target. ,
Required: False ,
}
[
{
appliesToMigrationTargetPlatform:
{
Required: False ,
}
string ,
featureId:
{
Required: False ,
}
string ,
impactedObjects:
{
Required: False ,
}
[
{
impactDetail:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
objectType:
{
Required: False ,
}
string ,
}
,
]
,
issueCategory:
{
Required: False ,
}
string ,
moreInformation:
{
Required: False ,
}
string ,
}
,
]
,
skuRecommendationResults:
{
Description: SKU Recommendation results for Azure migration targets for SQL Server. ,
Required: False ,
}
{
azureSqlDatabase:
{
Description: SKU Recommendation results for Azure SQL Database. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: maximum storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The maximum storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The maximum throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlManagedInstance:
{
Description: SKU Recommendation results for Azure SQL Managed Instance. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: maximum storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The maximum storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The maximum throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlVirtualMachine:
{
Description: SKU Recommendation results for Azure SQL Virtual Machine. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
availableVmSkus:
{
Description: Available VM SKUs for the Azure SQL Virtual Machine. ,
Required: False ,
}
[
string ,
]
,
virtualMachineFamily:
{
Description: The virtual machine family of the target SKU. ,
Required: False ,
}
string ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
virtualMachineSize:
{
Description: size parameters for VM size. ,
Required: False ,
}
{
virtualMachineFamily:
{
Description: Virtual Machine Family, for example : standardMSFamily ,
Required: False ,
}
string ,
sizeName:
{
Description: VM Size, for example : M64ls ,
Required: False ,
}
string ,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
azureSkuName:
{
Description: Virtual Machine SKU name,: Eg : Standard_F16s. ,
Required: False ,
}
string ,
vCPUsAvailable:
{
Description: Available vCores. This can be less than the vCores in the Constrained vCPU VM Sizes. ,
Format: int32 ,
Required: False ,
}
number ,
maxNetworkInterfaces:
{
Description: maximum network interfaces. ,
Format: int32 ,
Required: False ,
}
number ,
}
,
dataDiskSizes:
{
Description: Data disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
logDiskSizes:
{
Description: Log disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
tempDbDiskSizes:
{
Description: temp db disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}
,
impactedObjectsSummary:
{
Description: Represents a summary of migration readiness issues/warnings per feature type for Azure SQL DB and SQL MI targets ,
Required: False ,
}
{
azureSqlDatabase:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
azureSqlManagedInstance:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
bestPracticesAssessment:
{
Description: The configuration related to SQL best practices assessment. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if SQL best practices assessment is enabled for the SQL Server instance. ,
Required: False ,
}
boolean ,
schedule:
{
Description: The scheduling configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether scheduling is enabled. ,
Required: False ,
}
boolean ,
cronTrigger:
{
Description: The cron trigger configuration. ,
Required: False ,
}
{
startTime:
{
Description: Indicates the start time for the trigger. The default value is the time at which the trigger was created. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone in which the trigger is scheduled. ,
Required: False ,
}
string ,
expression:
{
Description: A cron string representing a CronTab expression. A crontab expression is a very compact way to express a recurring schedule with the following format: '{minutes} {hours} {days} {months} {days-of-week}'. ,
Required: False ,
}
string ,
}
,
}
,
}
,
clientConnection:
{
Description: Client connection related configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if client connection is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
}
,
serviceType:
{
Description: Indicates if the resource represents a SQL Server engine or a SQL Server component service installed on the host. ,
Enum:
{
Engine: SQL Server Database Services. ,
SSRS: SQL Server Reporting Services. ,
SSAS: SQL Server Analysis Services. ,
SSIS: SQL Server Integration Services. ,
PBIRS: Power BI Report Server. ,
}
,
Required: False ,
}
enum ,
maxServerMemoryMB:
{
Description: maximum server memory (MB) value configured for this instance. ,
Format: int64 ,
Required: False ,
}
integer ,
isMicrosoftPkiCertTrustConfigured:
{
Description: Indicates whether Microsoft PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. ,
Required: False ,
}
boolean ,
isDigiCertPkiCertTrustConfigured:
{
Description: Indicates whether DigiCert PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. ,
Required: False ,
}
boolean ,
authentication:
{
Description: Authentication related configuration for the SQL Server Instance. ,
Required: False ,
}
{
mode:
{
Description: Mode of authentication in SqlServer. ,
Enum:
{
Mixed: Mixed mode authentication for SQL Server which includes windows and SQL Authentication. ,
Windows: Windows Authentication for SQL Server. ,
Undefined: Used for scenarios were the mode cannot be determined. ,
}
,
Required: False ,
}
enum ,
sqlServerEntraIdentity:
{
Description: Entra Authentication configuration for the SQL Server Instance. ,
Required: False ,
}
[
{
identityType:
{
Description: The method used for Entra authentication ,
Enum:
{
SystemAssignedManagedIdentity: System Assigned Managed Identity ,
UserAssignedManagedIdentity: User Assigned Managed Identity ,
}
,
Required: False ,
}
enum ,
clientId:
{
Description: The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerInstances_Get (new)
Description :  Retrieves a SQL Server Instance resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: null ,
Required: False ,
}
{
version:
{
Description: SQL Server version. ,
Enum:
{
Unknown: No description available. ,
SQL Server 2012: No description available. ,
SQL Server 2014: No description available. ,
SQL Server 2016: No description available. ,
SQL Server 2017: No description available. ,
SQL Server 2019: No description available. ,
SQL Server 2022: No description available. ,
SQL Server 2025: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: SQL Server edition. ,
Enum:
{
Evaluation: No description available. ,
Enterprise: No description available. ,
Standard: No description available. ,
Web: No description available. ,
Developer: No description available. ,
Express: No description available. ,
Business Intelligence: No description available. ,
Standard Developer: No description available. ,
}
,
Required: False ,
}
enum ,
containerResourceId:
{
Description: ARM Resource id of the container resource (Azure Arc for Servers). ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
createTime:
{
Description: The time when the resource was created. ,
Required: False ,
}
string ,
vCore:
{
Description: The number of logical processors used by the SQL Server instance. ,
Required: False ,
}
string ,
cores:
{
Description: The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance. ,
Required: False ,
}
string ,
status:
{
Description: The cloud connectivity status. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Registered: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
patchLevel:
{
Description: SQL Server update level. ,
Required: False ,
}
string ,
collation:
{
Description: SQL Server collation. ,
Required: False ,
}
string ,
dbMasterKeyExists:
{
Description: Indicates whether database master key exists in SQL Server. ,
Required: False ,
}
boolean ,
isHadrEnabled:
{
Description: Indicates whether always On availability groups is enabled in SQL Server. ,
Required: False ,
}
boolean ,
traceFlags:
{
Description: An array of integers, where each value represents the enabled trace flags in SQL Server. ,
Required: False ,
}
[
integer ,
]
,
currentVersion:
{
Description: SQL Server current version. ,
Required: False ,
}
string ,
instanceName:
{
Description: SQL Server instance name. ,
Required: False ,
}
string ,
tcpDynamicPorts:
{
Description: Dynamic TCP ports used by SQL Server. ,
Required: False ,
}
string ,
tcpStaticPorts:
{
Description: Static TCP ports used by SQL Server. ,
Required: False ,
}
string ,
productId:
{
Description: SQL Server product ID. ,
Required: False ,
}
string ,
licenseType:
{
Description: SQL Server license type. ,
Enum:
{
Undefined: No description available. ,
Free: No description available. ,
HADR: No description available. ,
ServerCAL: No description available. ,
LicenseOnly: No description available. ,
PAYG: No description available. ,
Paid: No description available. ,
FabricCapacity: No description available. ,
}
,
Required: False ,
}
enum ,
azureDefenderStatusLastUpdated:
{
Description: Timestamp of last Azure Defender status update. ,
Format: date-time ,
Required: False ,
}
string ,
azureDefenderStatus:
{
Description: Status of Azure Defender. ,
Enum:
{
Protected: No description available. ,
Unprotected: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server resource. ,
Required: False ,
}
string ,
lastInventoryUploadTime:
{
Description: The time when last successful inventory upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUsageUploadTime:
{
Description: The time when last successful usage upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host for Azure Arc SQL Server ,
Enum:
{
Azure Virtual Machine: No description available. ,
Azure VMWare Virtual Machine: No description available. ,
Azure Kubernetes Service: No description available. ,
AWS VMWare Virtual Machine: No description available. ,
AWS Kubernetes Service: No description available. ,
GCP VMWare Virtual Machine: No description available. ,
GCP Kubernetes Service: No description available. ,
Container: No description available. ,
Virtual Machine: No description available. ,
Physical Server: No description available. ,
AWS Virtual Machine: No description available. ,
GCP Virtual Machine: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
alwaysOnRole:
{
Description: The role of the SQL Server, based on availability. ,
Enum:
{
None: No description available. ,
FailoverClusterInstance: No description available. ,
FailoverClusterNode: No description available. ,
AvailabilityGroupReplica: No description available. ,
}
,
Required: False ,
}
enum ,
databaseMirroringEndpoint:
{
Description: Database mirroring endpoint related properties. ,
Required: False ,
}
{
endpointName:
{
Description: Name of the database mirroring endpoint. ,
Required: False ,
}
string ,
role:
{
Description: Mirroring Role ,
Enum:
{
NONE: No description available. ,
PARTNER: No description available. ,
WITNESS: No description available. ,
ALL: No description available. ,
}
,
Required: False ,
}
enum ,
isEncryptionEnabled:
{
Description: Is Encryption enabled ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: Encryption Algorithm ,
Enum:
{
NONE: No description available. ,
RC4: No description available. ,
AES: No description available. ,
NONE, RC4: No description available. ,
NONE, AES: No description available. ,
RC4, AES: No description available. ,
AES, RC4: No description available. ,
NONE, RC4, AES: No description available. ,
NONE, AES, RC4: No description available. ,
}
,
Required: False ,
}
enum ,
connectionAuth:
{
Description: The type of connection authentication required for connections to this endpoint ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number that the endpoint is listening on. ,
Format: int32 ,
Required: False ,
}
integer ,
isDynamicPort:
{
Description: Is the port number dynamically assigned. ,
Required: False ,
}
boolean ,
ipAddress:
{
Description: Listener IP address. ,
Required: False ,
}
string ,
certificateName:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
certificateExpiryDate:
{
Description: The certificate expiry date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverCluster:
{
Description: Failover Cluster Instance properties. ,
Required: False ,
}
{
id:
{
Description: The GUID of the SQL Server's underlying Failover Cluster. ,
Required: False ,
}
string ,
networkName:
{
Description: The network name to connect to the SQL FCI. ,
Required: False ,
}
string ,
sqlInstanceIds:
{
Description: The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster. ,
Required: False ,
}
[
string ,
]
,
hostNames:
{
Description: The host names which are part of the SQL FCI resource group. ,
Required: False ,
}
[
string ,
]
,
hostIPAddresses:
{
Description: The IP addresses and subnet masks associated with the SQL Failover Cluster Instance on this host. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask ,
Required: False ,
}
string ,
}
,
]
,
}
,
backupPolicy:
{
Description: The backup profile for the SQL server. ,
Required: False ,
}
{
retentionPeriodDays:
{
Description: The retention period for all the databases in this managed instance. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupDays:
{
Description: The value indicating days between full backups. ,
Format: int32 ,
Required: False ,
}
integer ,
differentialBackupHours:
{
Description: The differential backup interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionLogBackupMinutes:
{
Description: The value indicating minutes between transaction log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
upgradeLockedUntil:
{
Description: Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty. ,
Format: date-time ,
Required: False ,
}
string ,
monitoring:
{
Description: The monitoring configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if monitoring is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
}
,
migration:
{
Description: Migration related configuration. ,
Required: False ,
}
{
assessment:
{
Description: Migration assessments related configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if migration assessment is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
assessmentUploadTime:
{
Description: The time when Migration Assessment Report upload was last performed. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: version of this migration assessment report - to be passed by the migration assessment engine. ,
Required: False ,
}
string ,
settings:
{
Description: Settings impacting the migration assessment computation - configurable with some default values if not set. ,
Required: False ,
}
{
targetLocation:
{
Description: The target location for Azure SQL SKU for migration. - default West US ,
Required: False ,
}
string ,
percentile:
{
Description: Indicate the percentile value for the performance sample. (Default is 95th percentile) ,
Format: float ,
Required: False ,
}
number ,
lookbackPeriodInDays:
{
Description: How far back to check the performance data - default is 30 (days). ,
Format: int32 ,
Required: False ,
}
number ,
strategy:
{
Description: Minimize cost or Migrate to PaaS. - to evaluate based on the recommended strategy ,
Required: False ,
}
string ,
currency:
{
Description: currency to calculate prices - default USD. ,
Required: False ,
}
string ,
discountPercentage:
{
Description: flat discount percentage to apply for the price - default 0 ,
Format: float ,
Required: False ,
}
number ,
costOptions:
{
Description: Selected cost option value. ,
Required: False ,
}
{
computeAndStorageCostOption:
{
Description: selected cost saving option e.g. With1YearASPAndDevTest. ,
Required: False ,
}
string ,
sqlLicenseCostOption:
{
Description: With Azure Hybrid Benefit(AHB) or not for SQL. ,
Required: False ,
}
string ,
windowsLicenseCostOption:
{
Description: With Azure Hybrid Benefit(AHB) or not for Windows. ,
Required: False ,
}
string ,
}
,
}
,
serverAssessments:
{
Description: Issues and warnings impacting the migration of SQL Server instance to particular Azure Migration Target. ,
Required: False ,
}
[
{
appliesToMigrationTargetPlatform:
{
Required: False ,
}
string ,
featureId:
{
Required: False ,
}
string ,
impactedObjects:
{
Required: False ,
}
[
{
impactDetail:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
objectType:
{
Required: False ,
}
string ,
}
,
]
,
issueCategory:
{
Required: False ,
}
string ,
moreInformation:
{
Required: False ,
}
string ,
}
,
]
,
skuRecommendationResults:
{
Description: SKU Recommendation results for Azure migration targets for SQL Server. ,
Required: False ,
}
{
azureSqlDatabase:
{
Description: SKU Recommendation results for Azure SQL Database. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: maximum storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The maximum storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The maximum throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlManagedInstance:
{
Description: SKU Recommendation results for Azure SQL Managed Instance. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: maximum storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The maximum storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The maximum throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlVirtualMachine:
{
Description: SKU Recommendation results for Azure SQL Virtual Machine. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
availableVmSkus:
{
Description: Available VM SKUs for the Azure SQL Virtual Machine. ,
Required: False ,
}
[
string ,
]
,
virtualMachineFamily:
{
Description: The virtual machine family of the target SKU. ,
Required: False ,
}
string ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
virtualMachineSize:
{
Description: size parameters for VM size. ,
Required: False ,
}
{
virtualMachineFamily:
{
Description: Virtual Machine Family, for example : standardMSFamily ,
Required: False ,
}
string ,
sizeName:
{
Description: VM Size, for example : M64ls ,
Required: False ,
}
string ,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
azureSkuName:
{
Description: Virtual Machine SKU name,: Eg : Standard_F16s. ,
Required: False ,
}
string ,
vCPUsAvailable:
{
Description: Available vCores. This can be less than the vCores in the Constrained vCPU VM Sizes. ,
Format: int32 ,
Required: False ,
}
number ,
maxNetworkInterfaces:
{
Description: maximum network interfaces. ,
Format: int32 ,
Required: False ,
}
number ,
}
,
dataDiskSizes:
{
Description: Data disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
logDiskSizes:
{
Description: Log disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
tempDbDiskSizes:
{
Description: temp db disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}
,
impactedObjectsSummary:
{
Description: Represents a summary of migration readiness issues/warnings per feature type for Azure SQL DB and SQL MI targets ,
Required: False ,
}
{
azureSqlDatabase:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
azureSqlManagedInstance:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
bestPracticesAssessment:
{
Description: The configuration related to SQL best practices assessment. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if SQL best practices assessment is enabled for the SQL Server instance. ,
Required: False ,
}
boolean ,
schedule:
{
Description: The scheduling configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether scheduling is enabled. ,
Required: False ,
}
boolean ,
cronTrigger:
{
Description: The cron trigger configuration. ,
Required: False ,
}
{
startTime:
{
Description: Indicates the start time for the trigger. The default value is the time at which the trigger was created. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone in which the trigger is scheduled. ,
Required: False ,
}
string ,
expression:
{
Description: A cron string representing a CronTab expression. A crontab expression is a very compact way to express a recurring schedule with the following format: '{minutes} {hours} {days} {months} {days-of-week}'. ,
Required: False ,
}
string ,
}
,
}
,
}
,
clientConnection:
{
Description: Client connection related configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if client connection is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
}
,
serviceType:
{
Description: Indicates if the resource represents a SQL Server engine or a SQL Server component service installed on the host. ,
Enum:
{
Engine: SQL Server Database Services. ,
SSRS: SQL Server Reporting Services. ,
SSAS: SQL Server Analysis Services. ,
SSIS: SQL Server Integration Services. ,
PBIRS: Power BI Report Server. ,
}
,
Required: False ,
}
enum ,
maxServerMemoryMB:
{
Description: maximum server memory (MB) value configured for this instance. ,
Format: int64 ,
Required: False ,
}
integer ,
isMicrosoftPkiCertTrustConfigured:
{
Description: Indicates whether Microsoft PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. ,
Required: False ,
}
boolean ,
isDigiCertPkiCertTrustConfigured:
{
Description: Indicates whether DigiCert PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. ,
Required: False ,
}
boolean ,
authentication:
{
Description: Authentication related configuration for the SQL Server Instance. ,
Required: False ,
}
{
mode:
{
Description: Mode of authentication in SqlServer. ,
Enum:
{
Mixed: Mixed mode authentication for SQL Server which includes windows and SQL Authentication. ,
Windows: Windows Authentication for SQL Server. ,
Undefined: Used for scenarios were the mode cannot be determined. ,
}
,
Required: False ,
}
enum ,
sqlServerEntraIdentity:
{
Description: Entra Authentication configuration for the SQL Server Instance. ,
Required: False ,
}
[
{
identityType:
{
Description: The method used for Entra authentication ,
Enum:
{
SystemAssignedManagedIdentity: System Assigned Managed Identity ,
UserAssignedManagedIdentity: User Assigned Managed Identity ,
}
,
Required: False ,
}
enum ,
clientId:
{
Description: The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerInstances_Create (new)
Description :  Creates or replaces a SQL Server Instance resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
sqlServerInstance:
{
Description: The SQL Server Instance to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: null ,
Required: False ,
}
{
version:
{
Description: SQL Server version. ,
Enum:
{
Unknown: No description available. ,
SQL Server 2012: No description available. ,
SQL Server 2014: No description available. ,
SQL Server 2016: No description available. ,
SQL Server 2017: No description available. ,
SQL Server 2019: No description available. ,
SQL Server 2022: No description available. ,
SQL Server 2025: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: SQL Server edition. ,
Enum:
{
Evaluation: No description available. ,
Enterprise: No description available. ,
Standard: No description available. ,
Web: No description available. ,
Developer: No description available. ,
Express: No description available. ,
Business Intelligence: No description available. ,
Standard Developer: No description available. ,
}
,
Required: False ,
}
enum ,
containerResourceId:
{
Description: ARM Resource id of the container resource (Azure Arc for Servers). ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
createTime:
{
Description: The time when the resource was created. ,
Required: False ,
}
string ,
vCore:
{
Description: The number of logical processors used by the SQL Server instance. ,
Required: False ,
}
string ,
cores:
{
Description: The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance. ,
Required: False ,
}
string ,
status:
{
Description: The cloud connectivity status. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Registered: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
patchLevel:
{
Description: SQL Server update level. ,
Required: False ,
}
string ,
collation:
{
Description: SQL Server collation. ,
Required: False ,
}
string ,
dbMasterKeyExists:
{
Description: Indicates whether database master key exists in SQL Server. ,
Required: False ,
}
boolean ,
isHadrEnabled:
{
Description: Indicates whether always On availability groups is enabled in SQL Server. ,
Required: False ,
}
boolean ,
traceFlags:
{
Description: An array of integers, where each value represents the enabled trace flags in SQL Server. ,
Required: False ,
}
[
integer ,
]
,
currentVersion:
{
Description: SQL Server current version. ,
Required: False ,
}
string ,
instanceName:
{
Description: SQL Server instance name. ,
Required: False ,
}
string ,
tcpDynamicPorts:
{
Description: Dynamic TCP ports used by SQL Server. ,
Required: False ,
}
string ,
tcpStaticPorts:
{
Description: Static TCP ports used by SQL Server. ,
Required: False ,
}
string ,
productId:
{
Description: SQL Server product ID. ,
Required: False ,
}
string ,
licenseType:
{
Description: SQL Server license type. ,
Enum:
{
Undefined: No description available. ,
Free: No description available. ,
HADR: No description available. ,
ServerCAL: No description available. ,
LicenseOnly: No description available. ,
PAYG: No description available. ,
Paid: No description available. ,
FabricCapacity: No description available. ,
}
,
Required: False ,
}
enum ,
azureDefenderStatusLastUpdated:
{
Description: Timestamp of last Azure Defender status update. ,
Format: date-time ,
Required: False ,
}
string ,
azureDefenderStatus:
{
Description: Status of Azure Defender. ,
Enum:
{
Protected: No description available. ,
Unprotected: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server resource. ,
Required: False ,
}
string ,
lastInventoryUploadTime:
{
Description: The time when last successful inventory upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUsageUploadTime:
{
Description: The time when last successful usage upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host for Azure Arc SQL Server ,
Enum:
{
Azure Virtual Machine: No description available. ,
Azure VMWare Virtual Machine: No description available. ,
Azure Kubernetes Service: No description available. ,
AWS VMWare Virtual Machine: No description available. ,
AWS Kubernetes Service: No description available. ,
GCP VMWare Virtual Machine: No description available. ,
GCP Kubernetes Service: No description available. ,
Container: No description available. ,
Virtual Machine: No description available. ,
Physical Server: No description available. ,
AWS Virtual Machine: No description available. ,
GCP Virtual Machine: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
alwaysOnRole:
{
Description: The role of the SQL Server, based on availability. ,
Enum:
{
None: No description available. ,
FailoverClusterInstance: No description available. ,
FailoverClusterNode: No description available. ,
AvailabilityGroupReplica: No description available. ,
}
,
Required: False ,
}
enum ,
databaseMirroringEndpoint:
{
Description: Database mirroring endpoint related properties. ,
Required: False ,
}
{
endpointName:
{
Description: Name of the database mirroring endpoint. ,
Required: False ,
}
string ,
role:
{
Description: Mirroring Role ,
Enum:
{
NONE: No description available. ,
PARTNER: No description available. ,
WITNESS: No description available. ,
ALL: No description available. ,
}
,
Required: False ,
}
enum ,
isEncryptionEnabled:
{
Description: Is Encryption enabled ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: Encryption Algorithm ,
Enum:
{
NONE: No description available. ,
RC4: No description available. ,
AES: No description available. ,
NONE, RC4: No description available. ,
NONE, AES: No description available. ,
RC4, AES: No description available. ,
AES, RC4: No description available. ,
NONE, RC4, AES: No description available. ,
NONE, AES, RC4: No description available. ,
}
,
Required: False ,
}
enum ,
connectionAuth:
{
Description: The type of connection authentication required for connections to this endpoint ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number that the endpoint is listening on. ,
Format: int32 ,
Required: False ,
}
integer ,
isDynamicPort:
{
Description: Is the port number dynamically assigned. ,
Required: False ,
}
boolean ,
ipAddress:
{
Description: Listener IP address. ,
Required: False ,
}
string ,
certificateName:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
certificateExpiryDate:
{
Description: The certificate expiry date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverCluster:
{
Description: Failover Cluster Instance properties. ,
Required: False ,
}
{
id:
{
Description: The GUID of the SQL Server's underlying Failover Cluster. ,
Required: False ,
}
string ,
networkName:
{
Description: The network name to connect to the SQL FCI. ,
Required: False ,
}
string ,
sqlInstanceIds:
{
Description: The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster. ,
Required: False ,
}
[
string ,
]
,
hostNames:
{
Description: The host names which are part of the SQL FCI resource group. ,
Required: False ,
}
[
string ,
]
,
hostIPAddresses:
{
Description: The IP addresses and subnet masks associated with the SQL Failover Cluster Instance on this host. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask ,
Required: False ,
}
string ,
}
,
]
,
}
,
backupPolicy:
{
Description: The backup profile for the SQL server. ,
Required: False ,
}
{
retentionPeriodDays:
{
Description: The retention period for all the databases in this managed instance. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupDays:
{
Description: The value indicating days between full backups. ,
Format: int32 ,
Required: False ,
}
integer ,
differentialBackupHours:
{
Description: The differential backup interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionLogBackupMinutes:
{
Description: The value indicating minutes between transaction log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
upgradeLockedUntil:
{
Description: Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty. ,
Format: date-time ,
Required: False ,
}
string ,
monitoring:
{
Description: The monitoring configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if monitoring is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
}
,
migration:
{
Description: Migration related configuration. ,
Required: False ,
}
{
assessment:
{
Description: Migration assessments related configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if migration assessment is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
assessmentUploadTime:
{
Description: The time when Migration Assessment Report upload was last performed. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: version of this migration assessment report - to be passed by the migration assessment engine. ,
Required: False ,
}
string ,
settings:
{
Description: Settings impacting the migration assessment computation - configurable with some default values if not set. ,
Required: False ,
}
{
targetLocation:
{
Description: The target location for Azure SQL SKU for migration. - default West US ,
Required: False ,
}
string ,
percentile:
{
Description: Indicate the percentile value for the performance sample. (Default is 95th percentile) ,
Format: float ,
Required: False ,
}
number ,
lookbackPeriodInDays:
{
Description: How far back to check the performance data - default is 30 (days). ,
Format: int32 ,
Required: False ,
}
number ,
strategy:
{
Description: Minimize cost or Migrate to PaaS. - to evaluate based on the recommended strategy ,
Required: False ,
}
string ,
currency:
{
Description: currency to calculate prices - default USD. ,
Required: False ,
}
string ,
discountPercentage:
{
Description: flat discount percentage to apply for the price - default 0 ,
Format: float ,
Required: False ,
}
number ,
costOptions:
{
Description: Selected cost option value. ,
Required: False ,
}
{
computeAndStorageCostOption:
{
Description: selected cost saving option e.g. With1YearASPAndDevTest. ,
Required: False ,
}
string ,
sqlLicenseCostOption:
{
Description: With Azure Hybrid Benefit(AHB) or not for SQL. ,
Required: False ,
}
string ,
windowsLicenseCostOption:
{
Description: With Azure Hybrid Benefit(AHB) or not for Windows. ,
Required: False ,
}
string ,
}
,
}
,
serverAssessments:
{
Description: Issues and warnings impacting the migration of SQL Server instance to particular Azure Migration Target. ,
Required: False ,
}
[
{
appliesToMigrationTargetPlatform:
{
Required: False ,
}
string ,
featureId:
{
Required: False ,
}
string ,
impactedObjects:
{
Required: False ,
}
[
{
impactDetail:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
objectType:
{
Required: False ,
}
string ,
}
,
]
,
issueCategory:
{
Required: False ,
}
string ,
moreInformation:
{
Required: False ,
}
string ,
}
,
]
,
skuRecommendationResults:
{
Description: SKU Recommendation results for Azure migration targets for SQL Server. ,
Required: False ,
}
{
azureSqlDatabase:
{
Description: SKU Recommendation results for Azure SQL Database. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: maximum storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The maximum storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The maximum throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlManagedInstance:
{
Description: SKU Recommendation results for Azure SQL Managed Instance. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: maximum storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The maximum storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The maximum throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlVirtualMachine:
{
Description: SKU Recommendation results for Azure SQL Virtual Machine. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
availableVmSkus:
{
Description: Available VM SKUs for the Azure SQL Virtual Machine. ,
Required: False ,
}
[
string ,
]
,
virtualMachineFamily:
{
Description: The virtual machine family of the target SKU. ,
Required: False ,
}
string ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
virtualMachineSize:
{
Description: size parameters for VM size. ,
Required: False ,
}
{
virtualMachineFamily:
{
Description: Virtual Machine Family, for example : standardMSFamily ,
Required: False ,
}
string ,
sizeName:
{
Description: VM Size, for example : M64ls ,
Required: False ,
}
string ,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
azureSkuName:
{
Description: Virtual Machine SKU name,: Eg : Standard_F16s. ,
Required: False ,
}
string ,
vCPUsAvailable:
{
Description: Available vCores. This can be less than the vCores in the Constrained vCPU VM Sizes. ,
Format: int32 ,
Required: False ,
}
number ,
maxNetworkInterfaces:
{
Description: maximum network interfaces. ,
Format: int32 ,
Required: False ,
}
number ,
}
,
dataDiskSizes:
{
Description: Data disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
logDiskSizes:
{
Description: Log disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
tempDbDiskSizes:
{
Description: temp db disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}
,
impactedObjectsSummary:
{
Description: Represents a summary of migration readiness issues/warnings per feature type for Azure SQL DB and SQL MI targets ,
Required: False ,
}
{
azureSqlDatabase:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
azureSqlManagedInstance:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
bestPracticesAssessment:
{
Description: The configuration related to SQL best practices assessment. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if SQL best practices assessment is enabled for the SQL Server instance. ,
Required: False ,
}
boolean ,
schedule:
{
Description: The scheduling configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether scheduling is enabled. ,
Required: False ,
}
boolean ,
cronTrigger:
{
Description: The cron trigger configuration. ,
Required: False ,
}
{
startTime:
{
Description: Indicates the start time for the trigger. The default value is the time at which the trigger was created. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone in which the trigger is scheduled. ,
Required: False ,
}
string ,
expression:
{
Description: A cron string representing a CronTab expression. A crontab expression is a very compact way to express a recurring schedule with the following format: '{minutes} {hours} {days} {months} {days-of-week}'. ,
Required: False ,
}
string ,
}
,
}
,
}
,
clientConnection:
{
Description: Client connection related configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if client connection is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
}
,
serviceType:
{
Description: Indicates if the resource represents a SQL Server engine or a SQL Server component service installed on the host. ,
Enum:
{
Engine: SQL Server Database Services. ,
SSRS: SQL Server Reporting Services. ,
SSAS: SQL Server Analysis Services. ,
SSIS: SQL Server Integration Services. ,
PBIRS: Power BI Report Server. ,
}
,
Required: False ,
}
enum ,
maxServerMemoryMB:
{
Description: maximum server memory (MB) value configured for this instance. ,
Format: int64 ,
Required: False ,
}
integer ,
isMicrosoftPkiCertTrustConfigured:
{
Description: Indicates whether Microsoft PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. ,
Required: False ,
}
boolean ,
isDigiCertPkiCertTrustConfigured:
{
Description: Indicates whether DigiCert PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. ,
Required: False ,
}
boolean ,
authentication:
{
Description: Authentication related configuration for the SQL Server Instance. ,
Required: False ,
}
{
mode:
{
Description: Mode of authentication in SqlServer. ,
Enum:
{
Mixed: Mixed mode authentication for SQL Server which includes windows and SQL Authentication. ,
Windows: Windows Authentication for SQL Server. ,
Undefined: Used for scenarios were the mode cannot be determined. ,
}
,
Required: False ,
}
enum ,
sqlServerEntraIdentity:
{
Description: Entra Authentication configuration for the SQL Server Instance. ,
Required: False ,
}
[
{
identityType:
{
Description: The method used for Entra authentication ,
Enum:
{
SystemAssignedManagedIdentity: System Assigned Managed Identity ,
UserAssignedManagedIdentity: User Assigned Managed Identity ,
}
,
Required: False ,
}
enum ,
clientId:
{
Description: The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: null ,
Required: False ,
}
{
version:
{
Description: SQL Server version. ,
Enum:
{
Unknown: No description available. ,
SQL Server 2012: No description available. ,
SQL Server 2014: No description available. ,
SQL Server 2016: No description available. ,
SQL Server 2017: No description available. ,
SQL Server 2019: No description available. ,
SQL Server 2022: No description available. ,
SQL Server 2025: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: SQL Server edition. ,
Enum:
{
Evaluation: No description available. ,
Enterprise: No description available. ,
Standard: No description available. ,
Web: No description available. ,
Developer: No description available. ,
Express: No description available. ,
Business Intelligence: No description available. ,
Standard Developer: No description available. ,
}
,
Required: False ,
}
enum ,
containerResourceId:
{
Description: ARM Resource id of the container resource (Azure Arc for Servers). ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
createTime:
{
Description: The time when the resource was created. ,
Required: False ,
}
string ,
vCore:
{
Description: The number of logical processors used by the SQL Server instance. ,
Required: False ,
}
string ,
cores:
{
Description: The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance. ,
Required: False ,
}
string ,
status:
{
Description: The cloud connectivity status. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Registered: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
patchLevel:
{
Description: SQL Server update level. ,
Required: False ,
}
string ,
collation:
{
Description: SQL Server collation. ,
Required: False ,
}
string ,
dbMasterKeyExists:
{
Description: Indicates whether database master key exists in SQL Server. ,
Required: False ,
}
boolean ,
isHadrEnabled:
{
Description: Indicates whether always On availability groups is enabled in SQL Server. ,
Required: False ,
}
boolean ,
traceFlags:
{
Description: An array of integers, where each value represents the enabled trace flags in SQL Server. ,
Required: False ,
}
[
integer ,
]
,
currentVersion:
{
Description: SQL Server current version. ,
Required: False ,
}
string ,
instanceName:
{
Description: SQL Server instance name. ,
Required: False ,
}
string ,
tcpDynamicPorts:
{
Description: Dynamic TCP ports used by SQL Server. ,
Required: False ,
}
string ,
tcpStaticPorts:
{
Description: Static TCP ports used by SQL Server. ,
Required: False ,
}
string ,
productId:
{
Description: SQL Server product ID. ,
Required: False ,
}
string ,
licenseType:
{
Description: SQL Server license type. ,
Enum:
{
Undefined: No description available. ,
Free: No description available. ,
HADR: No description available. ,
ServerCAL: No description available. ,
LicenseOnly: No description available. ,
PAYG: No description available. ,
Paid: No description available. ,
FabricCapacity: No description available. ,
}
,
Required: False ,
}
enum ,
azureDefenderStatusLastUpdated:
{
Description: Timestamp of last Azure Defender status update. ,
Format: date-time ,
Required: False ,
}
string ,
azureDefenderStatus:
{
Description: Status of Azure Defender. ,
Enum:
{
Protected: No description available. ,
Unprotected: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server resource. ,
Required: False ,
}
string ,
lastInventoryUploadTime:
{
Description: The time when last successful inventory upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUsageUploadTime:
{
Description: The time when last successful usage upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host for Azure Arc SQL Server ,
Enum:
{
Azure Virtual Machine: No description available. ,
Azure VMWare Virtual Machine: No description available. ,
Azure Kubernetes Service: No description available. ,
AWS VMWare Virtual Machine: No description available. ,
AWS Kubernetes Service: No description available. ,
GCP VMWare Virtual Machine: No description available. ,
GCP Kubernetes Service: No description available. ,
Container: No description available. ,
Virtual Machine: No description available. ,
Physical Server: No description available. ,
AWS Virtual Machine: No description available. ,
GCP Virtual Machine: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
alwaysOnRole:
{
Description: The role of the SQL Server, based on availability. ,
Enum:
{
None: No description available. ,
FailoverClusterInstance: No description available. ,
FailoverClusterNode: No description available. ,
AvailabilityGroupReplica: No description available. ,
}
,
Required: False ,
}
enum ,
databaseMirroringEndpoint:
{
Description: Database mirroring endpoint related properties. ,
Required: False ,
}
{
endpointName:
{
Description: Name of the database mirroring endpoint. ,
Required: False ,
}
string ,
role:
{
Description: Mirroring Role ,
Enum:
{
NONE: No description available. ,
PARTNER: No description available. ,
WITNESS: No description available. ,
ALL: No description available. ,
}
,
Required: False ,
}
enum ,
isEncryptionEnabled:
{
Description: Is Encryption enabled ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: Encryption Algorithm ,
Enum:
{
NONE: No description available. ,
RC4: No description available. ,
AES: No description available. ,
NONE, RC4: No description available. ,
NONE, AES: No description available. ,
RC4, AES: No description available. ,
AES, RC4: No description available. ,
NONE, RC4, AES: No description available. ,
NONE, AES, RC4: No description available. ,
}
,
Required: False ,
}
enum ,
connectionAuth:
{
Description: The type of connection authentication required for connections to this endpoint ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number that the endpoint is listening on. ,
Format: int32 ,
Required: False ,
}
integer ,
isDynamicPort:
{
Description: Is the port number dynamically assigned. ,
Required: False ,
}
boolean ,
ipAddress:
{
Description: Listener IP address. ,
Required: False ,
}
string ,
certificateName:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
certificateExpiryDate:
{
Description: The certificate expiry date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverCluster:
{
Description: Failover Cluster Instance properties. ,
Required: False ,
}
{
id:
{
Description: The GUID of the SQL Server's underlying Failover Cluster. ,
Required: False ,
}
string ,
networkName:
{
Description: The network name to connect to the SQL FCI. ,
Required: False ,
}
string ,
sqlInstanceIds:
{
Description: The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster. ,
Required: False ,
}
[
string ,
]
,
hostNames:
{
Description: The host names which are part of the SQL FCI resource group. ,
Required: False ,
}
[
string ,
]
,
hostIPAddresses:
{
Description: The IP addresses and subnet masks associated with the SQL Failover Cluster Instance on this host. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask ,
Required: False ,
}
string ,
}
,
]
,
}
,
backupPolicy:
{
Description: The backup profile for the SQL server. ,
Required: False ,
}
{
retentionPeriodDays:
{
Description: The retention period for all the databases in this managed instance. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupDays:
{
Description: The value indicating days between full backups. ,
Format: int32 ,
Required: False ,
}
integer ,
differentialBackupHours:
{
Description: The differential backup interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionLogBackupMinutes:
{
Description: The value indicating minutes between transaction log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
upgradeLockedUntil:
{
Description: Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty. ,
Format: date-time ,
Required: False ,
}
string ,
monitoring:
{
Description: The monitoring configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if monitoring is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
}
,
migration:
{
Description: Migration related configuration. ,
Required: False ,
}
{
assessment:
{
Description: Migration assessments related configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if migration assessment is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
assessmentUploadTime:
{
Description: The time when Migration Assessment Report upload was last performed. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: version of this migration assessment report - to be passed by the migration assessment engine. ,
Required: False ,
}
string ,
settings:
{
Description: Settings impacting the migration assessment computation - configurable with some default values if not set. ,
Required: False ,
}
{
targetLocation:
{
Description: The target location for Azure SQL SKU for migration. - default West US ,
Required: False ,
}
string ,
percentile:
{
Description: Indicate the percentile value for the performance sample. (Default is 95th percentile) ,
Format: float ,
Required: False ,
}
number ,
lookbackPeriodInDays:
{
Description: How far back to check the performance data - default is 30 (days). ,
Format: int32 ,
Required: False ,
}
number ,
strategy:
{
Description: Minimize cost or Migrate to PaaS. - to evaluate based on the recommended strategy ,
Required: False ,
}
string ,
currency:
{
Description: currency to calculate prices - default USD. ,
Required: False ,
}
string ,
discountPercentage:
{
Description: flat discount percentage to apply for the price - default 0 ,
Format: float ,
Required: False ,
}
number ,
costOptions:
{
Description: Selected cost option value. ,
Required: False ,
}
{
computeAndStorageCostOption:
{
Description: selected cost saving option e.g. With1YearASPAndDevTest. ,
Required: False ,
}
string ,
sqlLicenseCostOption:
{
Description: With Azure Hybrid Benefit(AHB) or not for SQL. ,
Required: False ,
}
string ,
windowsLicenseCostOption:
{
Description: With Azure Hybrid Benefit(AHB) or not for Windows. ,
Required: False ,
}
string ,
}
,
}
,
serverAssessments:
{
Description: Issues and warnings impacting the migration of SQL Server instance to particular Azure Migration Target. ,
Required: False ,
}
[
{
appliesToMigrationTargetPlatform:
{
Required: False ,
}
string ,
featureId:
{
Required: False ,
}
string ,
impactedObjects:
{
Required: False ,
}
[
{
impactDetail:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
objectType:
{
Required: False ,
}
string ,
}
,
]
,
issueCategory:
{
Required: False ,
}
string ,
moreInformation:
{
Required: False ,
}
string ,
}
,
]
,
skuRecommendationResults:
{
Description: SKU Recommendation results for Azure migration targets for SQL Server. ,
Required: False ,
}
{
azureSqlDatabase:
{
Description: SKU Recommendation results for Azure SQL Database. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: maximum storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The maximum storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The maximum throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlManagedInstance:
{
Description: SKU Recommendation results for Azure SQL Managed Instance. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: maximum storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The maximum storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The maximum throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlVirtualMachine:
{
Description: SKU Recommendation results for Azure SQL Virtual Machine. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
availableVmSkus:
{
Description: Available VM SKUs for the Azure SQL Virtual Machine. ,
Required: False ,
}
[
string ,
]
,
virtualMachineFamily:
{
Description: The virtual machine family of the target SKU. ,
Required: False ,
}
string ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
virtualMachineSize:
{
Description: size parameters for VM size. ,
Required: False ,
}
{
virtualMachineFamily:
{
Description: Virtual Machine Family, for example : standardMSFamily ,
Required: False ,
}
string ,
sizeName:
{
Description: VM Size, for example : M64ls ,
Required: False ,
}
string ,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
azureSkuName:
{
Description: Virtual Machine SKU name,: Eg : Standard_F16s. ,
Required: False ,
}
string ,
vCPUsAvailable:
{
Description: Available vCores. This can be less than the vCores in the Constrained vCPU VM Sizes. ,
Format: int32 ,
Required: False ,
}
number ,
maxNetworkInterfaces:
{
Description: maximum network interfaces. ,
Format: int32 ,
Required: False ,
}
number ,
}
,
dataDiskSizes:
{
Description: Data disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
logDiskSizes:
{
Description: Log disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
tempDbDiskSizes:
{
Description: temp db disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}
,
impactedObjectsSummary:
{
Description: Represents a summary of migration readiness issues/warnings per feature type for Azure SQL DB and SQL MI targets ,
Required: False ,
}
{
azureSqlDatabase:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
azureSqlManagedInstance:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
bestPracticesAssessment:
{
Description: The configuration related to SQL best practices assessment. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if SQL best practices assessment is enabled for the SQL Server instance. ,
Required: False ,
}
boolean ,
schedule:
{
Description: The scheduling configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether scheduling is enabled. ,
Required: False ,
}
boolean ,
cronTrigger:
{
Description: The cron trigger configuration. ,
Required: False ,
}
{
startTime:
{
Description: Indicates the start time for the trigger. The default value is the time at which the trigger was created. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone in which the trigger is scheduled. ,
Required: False ,
}
string ,
expression:
{
Description: A cron string representing a CronTab expression. A crontab expression is a very compact way to express a recurring schedule with the following format: '{minutes} {hours} {days} {months} {days-of-week}'. ,
Required: False ,
}
string ,
}
,
}
,
}
,
clientConnection:
{
Description: Client connection related configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if client connection is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
}
,
serviceType:
{
Description: Indicates if the resource represents a SQL Server engine or a SQL Server component service installed on the host. ,
Enum:
{
Engine: SQL Server Database Services. ,
SSRS: SQL Server Reporting Services. ,
SSAS: SQL Server Analysis Services. ,
SSIS: SQL Server Integration Services. ,
PBIRS: Power BI Report Server. ,
}
,
Required: False ,
}
enum ,
maxServerMemoryMB:
{
Description: maximum server memory (MB) value configured for this instance. ,
Format: int64 ,
Required: False ,
}
integer ,
isMicrosoftPkiCertTrustConfigured:
{
Description: Indicates whether Microsoft PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. ,
Required: False ,
}
boolean ,
isDigiCertPkiCertTrustConfigured:
{
Description: Indicates whether DigiCert PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. ,
Required: False ,
}
boolean ,
authentication:
{
Description: Authentication related configuration for the SQL Server Instance. ,
Required: False ,
}
{
mode:
{
Description: Mode of authentication in SqlServer. ,
Enum:
{
Mixed: Mixed mode authentication for SQL Server which includes windows and SQL Authentication. ,
Windows: Windows Authentication for SQL Server. ,
Undefined: Used for scenarios were the mode cannot be determined. ,
}
,
Required: False ,
}
enum ,
sqlServerEntraIdentity:
{
Description: Entra Authentication configuration for the SQL Server Instance. ,
Required: False ,
}
[
{
identityType:
{
Description: The method used for Entra authentication ,
Enum:
{
SystemAssignedManagedIdentity: System Assigned Managed Identity ,
UserAssignedManagedIdentity: User Assigned Managed Identity ,
}
,
Required: False ,
}
enum ,
clientId:
{
Description: The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: null ,
Required: False ,
}
{
version:
{
Description: SQL Server version. ,
Enum:
{
Unknown: No description available. ,
SQL Server 2012: No description available. ,
SQL Server 2014: No description available. ,
SQL Server 2016: No description available. ,
SQL Server 2017: No description available. ,
SQL Server 2019: No description available. ,
SQL Server 2022: No description available. ,
SQL Server 2025: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: SQL Server edition. ,
Enum:
{
Evaluation: No description available. ,
Enterprise: No description available. ,
Standard: No description available. ,
Web: No description available. ,
Developer: No description available. ,
Express: No description available. ,
Business Intelligence: No description available. ,
Standard Developer: No description available. ,
}
,
Required: False ,
}
enum ,
containerResourceId:
{
Description: ARM Resource id of the container resource (Azure Arc for Servers). ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
createTime:
{
Description: The time when the resource was created. ,
Required: False ,
}
string ,
vCore:
{
Description: The number of logical processors used by the SQL Server instance. ,
Required: False ,
}
string ,
cores:
{
Description: The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance. ,
Required: False ,
}
string ,
status:
{
Description: The cloud connectivity status. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Registered: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
patchLevel:
{
Description: SQL Server update level. ,
Required: False ,
}
string ,
collation:
{
Description: SQL Server collation. ,
Required: False ,
}
string ,
dbMasterKeyExists:
{
Description: Indicates whether database master key exists in SQL Server. ,
Required: False ,
}
boolean ,
isHadrEnabled:
{
Description: Indicates whether always On availability groups is enabled in SQL Server. ,
Required: False ,
}
boolean ,
traceFlags:
{
Description: An array of integers, where each value represents the enabled trace flags in SQL Server. ,
Required: False ,
}
[
integer ,
]
,
currentVersion:
{
Description: SQL Server current version. ,
Required: False ,
}
string ,
instanceName:
{
Description: SQL Server instance name. ,
Required: False ,
}
string ,
tcpDynamicPorts:
{
Description: Dynamic TCP ports used by SQL Server. ,
Required: False ,
}
string ,
tcpStaticPorts:
{
Description: Static TCP ports used by SQL Server. ,
Required: False ,
}
string ,
productId:
{
Description: SQL Server product ID. ,
Required: False ,
}
string ,
licenseType:
{
Description: SQL Server license type. ,
Enum:
{
Undefined: No description available. ,
Free: No description available. ,
HADR: No description available. ,
ServerCAL: No description available. ,
LicenseOnly: No description available. ,
PAYG: No description available. ,
Paid: No description available. ,
FabricCapacity: No description available. ,
}
,
Required: False ,
}
enum ,
azureDefenderStatusLastUpdated:
{
Description: Timestamp of last Azure Defender status update. ,
Format: date-time ,
Required: False ,
}
string ,
azureDefenderStatus:
{
Description: Status of Azure Defender. ,
Enum:
{
Protected: No description available. ,
Unprotected: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server resource. ,
Required: False ,
}
string ,
lastInventoryUploadTime:
{
Description: The time when last successful inventory upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUsageUploadTime:
{
Description: The time when last successful usage upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host for Azure Arc SQL Server ,
Enum:
{
Azure Virtual Machine: No description available. ,
Azure VMWare Virtual Machine: No description available. ,
Azure Kubernetes Service: No description available. ,
AWS VMWare Virtual Machine: No description available. ,
AWS Kubernetes Service: No description available. ,
GCP VMWare Virtual Machine: No description available. ,
GCP Kubernetes Service: No description available. ,
Container: No description available. ,
Virtual Machine: No description available. ,
Physical Server: No description available. ,
AWS Virtual Machine: No description available. ,
GCP Virtual Machine: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
alwaysOnRole:
{
Description: The role of the SQL Server, based on availability. ,
Enum:
{
None: No description available. ,
FailoverClusterInstance: No description available. ,
FailoverClusterNode: No description available. ,
AvailabilityGroupReplica: No description available. ,
}
,
Required: False ,
}
enum ,
databaseMirroringEndpoint:
{
Description: Database mirroring endpoint related properties. ,
Required: False ,
}
{
endpointName:
{
Description: Name of the database mirroring endpoint. ,
Required: False ,
}
string ,
role:
{
Description: Mirroring Role ,
Enum:
{
NONE: No description available. ,
PARTNER: No description available. ,
WITNESS: No description available. ,
ALL: No description available. ,
}
,
Required: False ,
}
enum ,
isEncryptionEnabled:
{
Description: Is Encryption enabled ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: Encryption Algorithm ,
Enum:
{
NONE: No description available. ,
RC4: No description available. ,
AES: No description available. ,
NONE, RC4: No description available. ,
NONE, AES: No description available. ,
RC4, AES: No description available. ,
AES, RC4: No description available. ,
NONE, RC4, AES: No description available. ,
NONE, AES, RC4: No description available. ,
}
,
Required: False ,
}
enum ,
connectionAuth:
{
Description: The type of connection authentication required for connections to this endpoint ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number that the endpoint is listening on. ,
Format: int32 ,
Required: False ,
}
integer ,
isDynamicPort:
{
Description: Is the port number dynamically assigned. ,
Required: False ,
}
boolean ,
ipAddress:
{
Description: Listener IP address. ,
Required: False ,
}
string ,
certificateName:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
certificateExpiryDate:
{
Description: The certificate expiry date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverCluster:
{
Description: Failover Cluster Instance properties. ,
Required: False ,
}
{
id:
{
Description: The GUID of the SQL Server's underlying Failover Cluster. ,
Required: False ,
}
string ,
networkName:
{
Description: The network name to connect to the SQL FCI. ,
Required: False ,
}
string ,
sqlInstanceIds:
{
Description: The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster. ,
Required: False ,
}
[
string ,
]
,
hostNames:
{
Description: The host names which are part of the SQL FCI resource group. ,
Required: False ,
}
[
string ,
]
,
hostIPAddresses:
{
Description: The IP addresses and subnet masks associated with the SQL Failover Cluster Instance on this host. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask ,
Required: False ,
}
string ,
}
,
]
,
}
,
backupPolicy:
{
Description: The backup profile for the SQL server. ,
Required: False ,
}
{
retentionPeriodDays:
{
Description: The retention period for all the databases in this managed instance. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupDays:
{
Description: The value indicating days between full backups. ,
Format: int32 ,
Required: False ,
}
integer ,
differentialBackupHours:
{
Description: The differential backup interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionLogBackupMinutes:
{
Description: The value indicating minutes between transaction log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
upgradeLockedUntil:
{
Description: Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty. ,
Format: date-time ,
Required: False ,
}
string ,
monitoring:
{
Description: The monitoring configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if monitoring is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
}
,
migration:
{
Description: Migration related configuration. ,
Required: False ,
}
{
assessment:
{
Description: Migration assessments related configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if migration assessment is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
assessmentUploadTime:
{
Description: The time when Migration Assessment Report upload was last performed. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: version of this migration assessment report - to be passed by the migration assessment engine. ,
Required: False ,
}
string ,
settings:
{
Description: Settings impacting the migration assessment computation - configurable with some default values if not set. ,
Required: False ,
}
{
targetLocation:
{
Description: The target location for Azure SQL SKU for migration. - default West US ,
Required: False ,
}
string ,
percentile:
{
Description: Indicate the percentile value for the performance sample. (Default is 95th percentile) ,
Format: float ,
Required: False ,
}
number ,
lookbackPeriodInDays:
{
Description: How far back to check the performance data - default is 30 (days). ,
Format: int32 ,
Required: False ,
}
number ,
strategy:
{
Description: Minimize cost or Migrate to PaaS. - to evaluate based on the recommended strategy ,
Required: False ,
}
string ,
currency:
{
Description: currency to calculate prices - default USD. ,
Required: False ,
}
string ,
discountPercentage:
{
Description: flat discount percentage to apply for the price - default 0 ,
Format: float ,
Required: False ,
}
number ,
costOptions:
{
Description: Selected cost option value. ,
Required: False ,
}
{
computeAndStorageCostOption:
{
Description: selected cost saving option e.g. With1YearASPAndDevTest. ,
Required: False ,
}
string ,
sqlLicenseCostOption:
{
Description: With Azure Hybrid Benefit(AHB) or not for SQL. ,
Required: False ,
}
string ,
windowsLicenseCostOption:
{
Description: With Azure Hybrid Benefit(AHB) or not for Windows. ,
Required: False ,
}
string ,
}
,
}
,
serverAssessments:
{
Description: Issues and warnings impacting the migration of SQL Server instance to particular Azure Migration Target. ,
Required: False ,
}
[
{
appliesToMigrationTargetPlatform:
{
Required: False ,
}
string ,
featureId:
{
Required: False ,
}
string ,
impactedObjects:
{
Required: False ,
}
[
{
impactDetail:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
objectType:
{
Required: False ,
}
string ,
}
,
]
,
issueCategory:
{
Required: False ,
}
string ,
moreInformation:
{
Required: False ,
}
string ,
}
,
]
,
skuRecommendationResults:
{
Description: SKU Recommendation results for Azure migration targets for SQL Server. ,
Required: False ,
}
{
azureSqlDatabase:
{
Description: SKU Recommendation results for Azure SQL Database. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: maximum storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The maximum storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The maximum throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlManagedInstance:
{
Description: SKU Recommendation results for Azure SQL Managed Instance. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: maximum storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The maximum storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The maximum throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlVirtualMachine:
{
Description: SKU Recommendation results for Azure SQL Virtual Machine. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
availableVmSkus:
{
Description: Available VM SKUs for the Azure SQL Virtual Machine. ,
Required: False ,
}
[
string ,
]
,
virtualMachineFamily:
{
Description: The virtual machine family of the target SKU. ,
Required: False ,
}
string ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
virtualMachineSize:
{
Description: size parameters for VM size. ,
Required: False ,
}
{
virtualMachineFamily:
{
Description: Virtual Machine Family, for example : standardMSFamily ,
Required: False ,
}
string ,
sizeName:
{
Description: VM Size, for example : M64ls ,
Required: False ,
}
string ,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
azureSkuName:
{
Description: Virtual Machine SKU name,: Eg : Standard_F16s. ,
Required: False ,
}
string ,
vCPUsAvailable:
{
Description: Available vCores. This can be less than the vCores in the Constrained vCPU VM Sizes. ,
Format: int32 ,
Required: False ,
}
number ,
maxNetworkInterfaces:
{
Description: maximum network interfaces. ,
Format: int32 ,
Required: False ,
}
number ,
}
,
dataDiskSizes:
{
Description: Data disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
logDiskSizes:
{
Description: Log disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
tempDbDiskSizes:
{
Description: temp db disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}
,
impactedObjectsSummary:
{
Description: Represents a summary of migration readiness issues/warnings per feature type for Azure SQL DB and SQL MI targets ,
Required: False ,
}
{
azureSqlDatabase:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
azureSqlManagedInstance:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
bestPracticesAssessment:
{
Description: The configuration related to SQL best practices assessment. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if SQL best practices assessment is enabled for the SQL Server instance. ,
Required: False ,
}
boolean ,
schedule:
{
Description: The scheduling configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether scheduling is enabled. ,
Required: False ,
}
boolean ,
cronTrigger:
{
Description: The cron trigger configuration. ,
Required: False ,
}
{
startTime:
{
Description: Indicates the start time for the trigger. The default value is the time at which the trigger was created. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone in which the trigger is scheduled. ,
Required: False ,
}
string ,
expression:
{
Description: A cron string representing a CronTab expression. A crontab expression is a very compact way to express a recurring schedule with the following format: '{minutes} {hours} {days} {months} {days-of-week}'. ,
Required: False ,
}
string ,
}
,
}
,
}
,
clientConnection:
{
Description: Client connection related configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if client connection is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
}
,
serviceType:
{
Description: Indicates if the resource represents a SQL Server engine or a SQL Server component service installed on the host. ,
Enum:
{
Engine: SQL Server Database Services. ,
SSRS: SQL Server Reporting Services. ,
SSAS: SQL Server Analysis Services. ,
SSIS: SQL Server Integration Services. ,
PBIRS: Power BI Report Server. ,
}
,
Required: False ,
}
enum ,
maxServerMemoryMB:
{
Description: maximum server memory (MB) value configured for this instance. ,
Format: int64 ,
Required: False ,
}
integer ,
isMicrosoftPkiCertTrustConfigured:
{
Description: Indicates whether Microsoft PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. ,
Required: False ,
}
boolean ,
isDigiCertPkiCertTrustConfigured:
{
Description: Indicates whether DigiCert PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. ,
Required: False ,
}
boolean ,
authentication:
{
Description: Authentication related configuration for the SQL Server Instance. ,
Required: False ,
}
{
mode:
{
Description: Mode of authentication in SqlServer. ,
Enum:
{
Mixed: Mixed mode authentication for SQL Server which includes windows and SQL Authentication. ,
Windows: Windows Authentication for SQL Server. ,
Undefined: Used for scenarios were the mode cannot be determined. ,
}
,
Required: False ,
}
enum ,
sqlServerEntraIdentity:
{
Description: Entra Authentication configuration for the SQL Server Instance. ,
Required: False ,
}
[
{
identityType:
{
Description: The method used for Entra authentication ,
Enum:
{
SystemAssignedManagedIdentity: System Assigned Managed Identity ,
UserAssignedManagedIdentity: User Assigned Managed Identity ,
}
,
Required: False ,
}
enum ,
clientId:
{
Description: The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerInstances_Delete (new)
Description :  Deletes a SQL Server Instance resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (204)

{}
SqlServerInstances_Update (new)
Description :  Updates a SQL Server Instance resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
parameters:
{
Description: The SQL Server Instance. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: null ,
Required: False ,
}
{
version:
{
Description: SQL Server version. ,
Enum:
{
Unknown: No description available. ,
SQL Server 2012: No description available. ,
SQL Server 2014: No description available. ,
SQL Server 2016: No description available. ,
SQL Server 2017: No description available. ,
SQL Server 2019: No description available. ,
SQL Server 2022: No description available. ,
SQL Server 2025: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: SQL Server edition. ,
Enum:
{
Evaluation: No description available. ,
Enterprise: No description available. ,
Standard: No description available. ,
Web: No description available. ,
Developer: No description available. ,
Express: No description available. ,
Business Intelligence: No description available. ,
Standard Developer: No description available. ,
}
,
Required: False ,
}
enum ,
containerResourceId:
{
Description: ARM Resource id of the container resource (Azure Arc for Servers). ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
createTime:
{
Description: The time when the resource was created. ,
Required: False ,
}
string ,
vCore:
{
Description: The number of logical processors used by the SQL Server instance. ,
Required: False ,
}
string ,
cores:
{
Description: The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance. ,
Required: False ,
}
string ,
status:
{
Description: The cloud connectivity status. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Registered: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
patchLevel:
{
Description: SQL Server update level. ,
Required: False ,
}
string ,
collation:
{
Description: SQL Server collation. ,
Required: False ,
}
string ,
dbMasterKeyExists:
{
Description: Indicates whether database master key exists in SQL Server. ,
Required: False ,
}
boolean ,
isHadrEnabled:
{
Description: Indicates whether always On availability groups is enabled in SQL Server. ,
Required: False ,
}
boolean ,
traceFlags:
{
Description: An array of integers, where each value represents the enabled trace flags in SQL Server. ,
Required: False ,
}
[
integer ,
]
,
currentVersion:
{
Description: SQL Server current version. ,
Required: False ,
}
string ,
instanceName:
{
Description: SQL Server instance name. ,
Required: False ,
}
string ,
tcpDynamicPorts:
{
Description: Dynamic TCP ports used by SQL Server. ,
Required: False ,
}
string ,
tcpStaticPorts:
{
Description: Static TCP ports used by SQL Server. ,
Required: False ,
}
string ,
productId:
{
Description: SQL Server product ID. ,
Required: False ,
}
string ,
licenseType:
{
Description: SQL Server license type. ,
Enum:
{
Undefined: No description available. ,
Free: No description available. ,
HADR: No description available. ,
ServerCAL: No description available. ,
LicenseOnly: No description available. ,
PAYG: No description available. ,
Paid: No description available. ,
FabricCapacity: No description available. ,
}
,
Required: False ,
}
enum ,
azureDefenderStatusLastUpdated:
{
Description: Timestamp of last Azure Defender status update. ,
Format: date-time ,
Required: False ,
}
string ,
azureDefenderStatus:
{
Description: Status of Azure Defender. ,
Enum:
{
Protected: No description available. ,
Unprotected: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server resource. ,
Required: False ,
}
string ,
lastInventoryUploadTime:
{
Description: The time when last successful inventory upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUsageUploadTime:
{
Description: The time when last successful usage upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host for Azure Arc SQL Server ,
Enum:
{
Azure Virtual Machine: No description available. ,
Azure VMWare Virtual Machine: No description available. ,
Azure Kubernetes Service: No description available. ,
AWS VMWare Virtual Machine: No description available. ,
AWS Kubernetes Service: No description available. ,
GCP VMWare Virtual Machine: No description available. ,
GCP Kubernetes Service: No description available. ,
Container: No description available. ,
Virtual Machine: No description available. ,
Physical Server: No description available. ,
AWS Virtual Machine: No description available. ,
GCP Virtual Machine: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
alwaysOnRole:
{
Description: The role of the SQL Server, based on availability. ,
Enum:
{
None: No description available. ,
FailoverClusterInstance: No description available. ,
FailoverClusterNode: No description available. ,
AvailabilityGroupReplica: No description available. ,
}
,
Required: False ,
}
enum ,
failoverCluster:
{
Description: Failover Cluster Instance properties. ,
Required: False ,
}
{
id:
{
Description: The GUID of the SQL Server's underlying Failover Cluster. ,
Required: False ,
}
string ,
networkName:
{
Description: The network name to connect to the SQL FCI. ,
Required: False ,
}
string ,
sqlInstanceIds:
{
Description: The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster. ,
Required: False ,
}
[
string ,
]
,
hostNames:
{
Description: The host names which are part of the SQL FCI resource group. ,
Required: False ,
}
[
string ,
]
,
hostIPAddresses:
{
Description: The IP addresses and subnet masks associated with the SQL Failover Cluster Instance on this host. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask ,
Required: False ,
}
string ,
}
,
]
,
}
,
backupPolicy:
{
Description: The backup profile for the SQL server. ,
Required: False ,
}
{
retentionPeriodDays:
{
Description: The retention period for all the databases in this managed instance. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupDays:
{
Description: The value indicating days between full backups. ,
Format: int32 ,
Required: False ,
}
integer ,
differentialBackupHours:
{
Description: The differential backup interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionLogBackupMinutes:
{
Description: The value indicating minutes between transaction log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
upgradeLockedUntil:
{
Description: Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty. ,
Format: date-time ,
Required: False ,
}
string ,
monitoring:
{
Description: The monitoring configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if monitoring is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
}
,
migration:
{
Description: Migration related configuration. ,
Required: False ,
}
{
assessment:
{
Description: Migration assessments related configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if migration assessment is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
assessmentUploadTime:
{
Description: The time when Migration Assessment Report upload was last performed. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: version of this migration assessment report - to be passed by the migration assessment engine. ,
Required: False ,
}
string ,
settings:
{
Description: Settings impacting the migration assessment computation - configurable with some default values if not set. ,
Required: False ,
}
{
targetLocation:
{
Description: The target location for Azure SQL SKU for migration. - default West US ,
Required: False ,
}
string ,
percentile:
{
Description: Indicate the percentile value for the performance sample. (Default is 95th percentile) ,
Format: float ,
Required: False ,
}
number ,
lookbackPeriodInDays:
{
Description: How far back to check the performance data - default is 30 (days). ,
Format: int32 ,
Required: False ,
}
number ,
strategy:
{
Description: Minimize cost or Migrate to PaaS. - to evaluate based on the recommended strategy ,
Required: False ,
}
string ,
currency:
{
Description: currency to calculate prices - default USD. ,
Required: False ,
}
string ,
discountPercentage:
{
Description: flat discount percentage to apply for the price - default 0 ,
Format: float ,
Required: False ,
}
number ,
costOptions:
{
Description: Selected cost option value. ,
Required: False ,
}
{
computeAndStorageCostOption:
{
Description: selected cost saving option e.g. With1YearASPAndDevTest. ,
Required: False ,
}
string ,
sqlLicenseCostOption:
{
Description: With Azure Hybrid Benefit(AHB) or not for SQL. ,
Required: False ,
}
string ,
windowsLicenseCostOption:
{
Description: With Azure Hybrid Benefit(AHB) or not for Windows. ,
Required: False ,
}
string ,
}
,
}
,
serverAssessments:
{
Description: Issues and warnings impacting the migration of SQL Server instance to particular Azure Migration Target. ,
Required: False ,
}
[
{
appliesToMigrationTargetPlatform:
{
Required: False ,
}
string ,
featureId:
{
Required: False ,
}
string ,
impactedObjects:
{
Required: False ,
}
[
{
impactDetail:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
objectType:
{
Required: False ,
}
string ,
}
,
]
,
issueCategory:
{
Required: False ,
}
string ,
moreInformation:
{
Required: False ,
}
string ,
}
,
]
,
skuRecommendationResults:
{
Description: SKU Recommendation results for Azure migration targets for SQL Server. ,
Required: False ,
}
{
azureSqlDatabase:
{
Description: SKU Recommendation results for Azure SQL Database. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: maximum storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The maximum storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The maximum throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlManagedInstance:
{
Description: SKU Recommendation results for Azure SQL Managed Instance. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: maximum storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The maximum storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The maximum throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlVirtualMachine:
{
Description: SKU Recommendation results for Azure SQL Virtual Machine. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
availableVmSkus:
{
Description: Available VM SKUs for the Azure SQL Virtual Machine. ,
Required: False ,
}
[
string ,
]
,
virtualMachineFamily:
{
Description: The virtual machine family of the target SKU. ,
Required: False ,
}
string ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
virtualMachineSize:
{
Description: size parameters for VM size. ,
Required: False ,
}
{
virtualMachineFamily:
{
Description: Virtual Machine Family, for example : standardMSFamily ,
Required: False ,
}
string ,
sizeName:
{
Description: VM Size, for example : M64ls ,
Required: False ,
}
string ,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
azureSkuName:
{
Description: Virtual Machine SKU name,: Eg : Standard_F16s. ,
Required: False ,
}
string ,
vCPUsAvailable:
{
Description: Available vCores. This can be less than the vCores in the Constrained vCPU VM Sizes. ,
Format: int32 ,
Required: False ,
}
number ,
maxNetworkInterfaces:
{
Description: maximum network interfaces. ,
Format: int32 ,
Required: False ,
}
number ,
}
,
dataDiskSizes:
{
Description: Data disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
logDiskSizes:
{
Description: Log disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
tempDbDiskSizes:
{
Description: temp db disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}
,
impactedObjectsSummary:
{
Description: Represents a summary of migration readiness issues/warnings per feature type for Azure SQL DB and SQL MI targets ,
Required: False ,
}
{
azureSqlDatabase:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
azureSqlManagedInstance:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
bestPracticesAssessment:
{
Description: The configuration related to SQL best practices assessment. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if SQL best practices assessment is enabled for the SQL Server instance. ,
Required: False ,
}
boolean ,
schedule:
{
Description: The scheduling configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether scheduling is enabled. ,
Required: False ,
}
boolean ,
cronTrigger:
{
Description: The cron trigger configuration. ,
Required: False ,
}
{
startTime:
{
Description: Indicates the start time for the trigger. The default value is the time at which the trigger was created. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone in which the trigger is scheduled. ,
Required: False ,
}
string ,
expression:
{
Description: A cron string representing a CronTab expression. A crontab expression is a very compact way to express a recurring schedule with the following format: '{minutes} {hours} {days} {months} {days-of-week}'. ,
Required: False ,
}
string ,
}
,
}
,
}
,
clientConnection:
{
Description: Client connection related configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if client connection is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
}
,
serviceType:
{
Description: Indicates if the resource represents a SQL Server engine or a SQL Server component service installed on the host. ,
Enum:
{
Engine: SQL Server Database Services. ,
SSRS: SQL Server Reporting Services. ,
SSAS: SQL Server Analysis Services. ,
SSIS: SQL Server Integration Services. ,
PBIRS: Power BI Report Server. ,
}
,
Required: False ,
}
enum ,
authentication:
{
Description: Authentication related configuration for the SQL Server Instance. ,
Required: False ,
}
{
mode:
{
Description: Mode of authentication in SqlServer. ,
Enum:
{
Mixed: Mixed mode authentication for SQL Server which includes windows and SQL Authentication. ,
Windows: Windows Authentication for SQL Server. ,
Undefined: Used for scenarios were the mode cannot be determined. ,
}
,
Required: False ,
}
enum ,
sqlServerEntraIdentity:
{
Description: Entra Authentication configuration for the SQL Server Instance. ,
Required: False ,
}
[
{
identityType:
{
Description: The method used for Entra authentication ,
Enum:
{
SystemAssignedManagedIdentity: System Assigned Managed Identity ,
UserAssignedManagedIdentity: User Assigned Managed Identity ,
}
,
Required: False ,
}
enum ,
clientId:
{
Description: The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity. ,
Required: False ,
}
string ,
}
,
]
,
}
,
databaseMirroringEndpoint:
{
Description: Database mirroring endpoint related properties. ,
Required: False ,
}
{
endpointName:
{
Description: Name of the database mirroring endpoint. ,
Required: False ,
}
string ,
role:
{
Description: Mirroring Role ,
Enum:
{
NONE: No description available. ,
PARTNER: No description available. ,
WITNESS: No description available. ,
ALL: No description available. ,
}
,
Required: False ,
}
enum ,
isEncryptionEnabled:
{
Description: Is Encryption enabled ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: Encryption Algorithm ,
Enum:
{
NONE: No description available. ,
RC4: No description available. ,
AES: No description available. ,
NONE, RC4: No description available. ,
NONE, AES: No description available. ,
RC4, AES: No description available. ,
AES, RC4: No description available. ,
NONE, RC4, AES: No description available. ,
NONE, AES, RC4: No description available. ,
}
,
Required: False ,
}
enum ,
connectionAuth:
{
Description: The type of connection authentication required for connections to this endpoint ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number that the endpoint is listening on. ,
Format: int32 ,
Required: False ,
}
integer ,
isDynamicPort:
{
Description: Is the port number dynamically assigned. ,
Required: False ,
}
boolean ,
ipAddress:
{
Description: Listener IP address. ,
Required: False ,
}
string ,
certificateName:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
certificateExpiryDate:
{
Description: The certificate expiry date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isMicrosoftPkiCertTrustConfigured:
{
Description: Indicates whether Microsoft PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. ,
Required: False ,
}
boolean ,
isDigiCertPkiCertTrustConfigured:
{
Description: Indicates whether DigiCert PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. ,
Required: False ,
}
boolean ,
maxServerMemoryMB:
{
Description: maximum server memory (MB) value configured for this instance. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: null ,
Required: False ,
}
{
version:
{
Description: SQL Server version. ,
Enum:
{
Unknown: No description available. ,
SQL Server 2012: No description available. ,
SQL Server 2014: No description available. ,
SQL Server 2016: No description available. ,
SQL Server 2017: No description available. ,
SQL Server 2019: No description available. ,
SQL Server 2022: No description available. ,
SQL Server 2025: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: SQL Server edition. ,
Enum:
{
Evaluation: No description available. ,
Enterprise: No description available. ,
Standard: No description available. ,
Web: No description available. ,
Developer: No description available. ,
Express: No description available. ,
Business Intelligence: No description available. ,
Standard Developer: No description available. ,
}
,
Required: False ,
}
enum ,
containerResourceId:
{
Description: ARM Resource id of the container resource (Azure Arc for Servers). ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
createTime:
{
Description: The time when the resource was created. ,
Required: False ,
}
string ,
vCore:
{
Description: The number of logical processors used by the SQL Server instance. ,
Required: False ,
}
string ,
cores:
{
Description: The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance. ,
Required: False ,
}
string ,
status:
{
Description: The cloud connectivity status. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Registered: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
patchLevel:
{
Description: SQL Server update level. ,
Required: False ,
}
string ,
collation:
{
Description: SQL Server collation. ,
Required: False ,
}
string ,
dbMasterKeyExists:
{
Description: Indicates whether database master key exists in SQL Server. ,
Required: False ,
}
boolean ,
isHadrEnabled:
{
Description: Indicates whether always On availability groups is enabled in SQL Server. ,
Required: False ,
}
boolean ,
traceFlags:
{
Description: An array of integers, where each value represents the enabled trace flags in SQL Server. ,
Required: False ,
}
[
integer ,
]
,
currentVersion:
{
Description: SQL Server current version. ,
Required: False ,
}
string ,
instanceName:
{
Description: SQL Server instance name. ,
Required: False ,
}
string ,
tcpDynamicPorts:
{
Description: Dynamic TCP ports used by SQL Server. ,
Required: False ,
}
string ,
tcpStaticPorts:
{
Description: Static TCP ports used by SQL Server. ,
Required: False ,
}
string ,
productId:
{
Description: SQL Server product ID. ,
Required: False ,
}
string ,
licenseType:
{
Description: SQL Server license type. ,
Enum:
{
Undefined: No description available. ,
Free: No description available. ,
HADR: No description available. ,
ServerCAL: No description available. ,
LicenseOnly: No description available. ,
PAYG: No description available. ,
Paid: No description available. ,
FabricCapacity: No description available. ,
}
,
Required: False ,
}
enum ,
azureDefenderStatusLastUpdated:
{
Description: Timestamp of last Azure Defender status update. ,
Format: date-time ,
Required: False ,
}
string ,
azureDefenderStatus:
{
Description: Status of Azure Defender. ,
Enum:
{
Protected: No description available. ,
Unprotected: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server resource. ,
Required: False ,
}
string ,
lastInventoryUploadTime:
{
Description: The time when last successful inventory upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUsageUploadTime:
{
Description: The time when last successful usage upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host for Azure Arc SQL Server ,
Enum:
{
Azure Virtual Machine: No description available. ,
Azure VMWare Virtual Machine: No description available. ,
Azure Kubernetes Service: No description available. ,
AWS VMWare Virtual Machine: No description available. ,
AWS Kubernetes Service: No description available. ,
GCP VMWare Virtual Machine: No description available. ,
GCP Kubernetes Service: No description available. ,
Container: No description available. ,
Virtual Machine: No description available. ,
Physical Server: No description available. ,
AWS Virtual Machine: No description available. ,
GCP Virtual Machine: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
alwaysOnRole:
{
Description: The role of the SQL Server, based on availability. ,
Enum:
{
None: No description available. ,
FailoverClusterInstance: No description available. ,
FailoverClusterNode: No description available. ,
AvailabilityGroupReplica: No description available. ,
}
,
Required: False ,
}
enum ,
databaseMirroringEndpoint:
{
Description: Database mirroring endpoint related properties. ,
Required: False ,
}
{
endpointName:
{
Description: Name of the database mirroring endpoint. ,
Required: False ,
}
string ,
role:
{
Description: Mirroring Role ,
Enum:
{
NONE: No description available. ,
PARTNER: No description available. ,
WITNESS: No description available. ,
ALL: No description available. ,
}
,
Required: False ,
}
enum ,
isEncryptionEnabled:
{
Description: Is Encryption enabled ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: Encryption Algorithm ,
Enum:
{
NONE: No description available. ,
RC4: No description available. ,
AES: No description available. ,
NONE, RC4: No description available. ,
NONE, AES: No description available. ,
RC4, AES: No description available. ,
AES, RC4: No description available. ,
NONE, RC4, AES: No description available. ,
NONE, AES, RC4: No description available. ,
}
,
Required: False ,
}
enum ,
connectionAuth:
{
Description: The type of connection authentication required for connections to this endpoint ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number that the endpoint is listening on. ,
Format: int32 ,
Required: False ,
}
integer ,
isDynamicPort:
{
Description: Is the port number dynamically assigned. ,
Required: False ,
}
boolean ,
ipAddress:
{
Description: Listener IP address. ,
Required: False ,
}
string ,
certificateName:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
certificateExpiryDate:
{
Description: The certificate expiry date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverCluster:
{
Description: Failover Cluster Instance properties. ,
Required: False ,
}
{
id:
{
Description: The GUID of the SQL Server's underlying Failover Cluster. ,
Required: False ,
}
string ,
networkName:
{
Description: The network name to connect to the SQL FCI. ,
Required: False ,
}
string ,
sqlInstanceIds:
{
Description: The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster. ,
Required: False ,
}
[
string ,
]
,
hostNames:
{
Description: The host names which are part of the SQL FCI resource group. ,
Required: False ,
}
[
string ,
]
,
hostIPAddresses:
{
Description: The IP addresses and subnet masks associated with the SQL Failover Cluster Instance on this host. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask ,
Required: False ,
}
string ,
}
,
]
,
}
,
backupPolicy:
{
Description: The backup profile for the SQL server. ,
Required: False ,
}
{
retentionPeriodDays:
{
Description: The retention period for all the databases in this managed instance. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupDays:
{
Description: The value indicating days between full backups. ,
Format: int32 ,
Required: False ,
}
integer ,
differentialBackupHours:
{
Description: The differential backup interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionLogBackupMinutes:
{
Description: The value indicating minutes between transaction log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
upgradeLockedUntil:
{
Description: Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty. ,
Format: date-time ,
Required: False ,
}
string ,
monitoring:
{
Description: The monitoring configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if monitoring is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
}
,
migration:
{
Description: Migration related configuration. ,
Required: False ,
}
{
assessment:
{
Description: Migration assessments related configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if migration assessment is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
assessmentUploadTime:
{
Description: The time when Migration Assessment Report upload was last performed. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: version of this migration assessment report - to be passed by the migration assessment engine. ,
Required: False ,
}
string ,
settings:
{
Description: Settings impacting the migration assessment computation - configurable with some default values if not set. ,
Required: False ,
}
{
targetLocation:
{
Description: The target location for Azure SQL SKU for migration. - default West US ,
Required: False ,
}
string ,
percentile:
{
Description: Indicate the percentile value for the performance sample. (Default is 95th percentile) ,
Format: float ,
Required: False ,
}
number ,
lookbackPeriodInDays:
{
Description: How far back to check the performance data - default is 30 (days). ,
Format: int32 ,
Required: False ,
}
number ,
strategy:
{
Description: Minimize cost or Migrate to PaaS. - to evaluate based on the recommended strategy ,
Required: False ,
}
string ,
currency:
{
Description: currency to calculate prices - default USD. ,
Required: False ,
}
string ,
discountPercentage:
{
Description: flat discount percentage to apply for the price - default 0 ,
Format: float ,
Required: False ,
}
number ,
costOptions:
{
Description: Selected cost option value. ,
Required: False ,
}
{
computeAndStorageCostOption:
{
Description: selected cost saving option e.g. With1YearASPAndDevTest. ,
Required: False ,
}
string ,
sqlLicenseCostOption:
{
Description: With Azure Hybrid Benefit(AHB) or not for SQL. ,
Required: False ,
}
string ,
windowsLicenseCostOption:
{
Description: With Azure Hybrid Benefit(AHB) or not for Windows. ,
Required: False ,
}
string ,
}
,
}
,
serverAssessments:
{
Description: Issues and warnings impacting the migration of SQL Server instance to particular Azure Migration Target. ,
Required: False ,
}
[
{
appliesToMigrationTargetPlatform:
{
Required: False ,
}
string ,
featureId:
{
Required: False ,
}
string ,
impactedObjects:
{
Required: False ,
}
[
{
impactDetail:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
objectType:
{
Required: False ,
}
string ,
}
,
]
,
issueCategory:
{
Required: False ,
}
string ,
moreInformation:
{
Required: False ,
}
string ,
}
,
]
,
skuRecommendationResults:
{
Description: SKU Recommendation results for Azure migration targets for SQL Server. ,
Required: False ,
}
{
azureSqlDatabase:
{
Description: SKU Recommendation results for Azure SQL Database. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: maximum storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The maximum storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The maximum throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlManagedInstance:
{
Description: SKU Recommendation results for Azure SQL Managed Instance. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: maximum storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The maximum storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The maximum throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlVirtualMachine:
{
Description: SKU Recommendation results for Azure SQL Virtual Machine. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
availableVmSkus:
{
Description: Available VM SKUs for the Azure SQL Virtual Machine. ,
Required: False ,
}
[
string ,
]
,
virtualMachineFamily:
{
Description: The virtual machine family of the target SKU. ,
Required: False ,
}
string ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
virtualMachineSize:
{
Description: size parameters for VM size. ,
Required: False ,
}
{
virtualMachineFamily:
{
Description: Virtual Machine Family, for example : standardMSFamily ,
Required: False ,
}
string ,
sizeName:
{
Description: VM Size, for example : M64ls ,
Required: False ,
}
string ,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
azureSkuName:
{
Description: Virtual Machine SKU name,: Eg : Standard_F16s. ,
Required: False ,
}
string ,
vCPUsAvailable:
{
Description: Available vCores. This can be less than the vCores in the Constrained vCPU VM Sizes. ,
Format: int32 ,
Required: False ,
}
number ,
maxNetworkInterfaces:
{
Description: maximum network interfaces. ,
Format: int32 ,
Required: False ,
}
number ,
}
,
dataDiskSizes:
{
Description: Data disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
logDiskSizes:
{
Description: Log disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
tempDbDiskSizes:
{
Description: temp db disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}
,
impactedObjectsSummary:
{
Description: Represents a summary of migration readiness issues/warnings per feature type for Azure SQL DB and SQL MI targets ,
Required: False ,
}
{
azureSqlDatabase:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
azureSqlManagedInstance:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
bestPracticesAssessment:
{
Description: The configuration related to SQL best practices assessment. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if SQL best practices assessment is enabled for the SQL Server instance. ,
Required: False ,
}
boolean ,
schedule:
{
Description: The scheduling configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether scheduling is enabled. ,
Required: False ,
}
boolean ,
cronTrigger:
{
Description: The cron trigger configuration. ,
Required: False ,
}
{
startTime:
{
Description: Indicates the start time for the trigger. The default value is the time at which the trigger was created. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone in which the trigger is scheduled. ,
Required: False ,
}
string ,
expression:
{
Description: A cron string representing a CronTab expression. A crontab expression is a very compact way to express a recurring schedule with the following format: '{minutes} {hours} {days} {months} {days-of-week}'. ,
Required: False ,
}
string ,
}
,
}
,
}
,
clientConnection:
{
Description: Client connection related configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if client connection is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
}
,
serviceType:
{
Description: Indicates if the resource represents a SQL Server engine or a SQL Server component service installed on the host. ,
Enum:
{
Engine: SQL Server Database Services. ,
SSRS: SQL Server Reporting Services. ,
SSAS: SQL Server Analysis Services. ,
SSIS: SQL Server Integration Services. ,
PBIRS: Power BI Report Server. ,
}
,
Required: False ,
}
enum ,
maxServerMemoryMB:
{
Description: maximum server memory (MB) value configured for this instance. ,
Format: int64 ,
Required: False ,
}
integer ,
isMicrosoftPkiCertTrustConfigured:
{
Description: Indicates whether Microsoft PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. ,
Required: False ,
}
boolean ,
isDigiCertPkiCertTrustConfigured:
{
Description: Indicates whether DigiCert PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. ,
Required: False ,
}
boolean ,
authentication:
{
Description: Authentication related configuration for the SQL Server Instance. ,
Required: False ,
}
{
mode:
{
Description: Mode of authentication in SqlServer. ,
Enum:
{
Mixed: Mixed mode authentication for SQL Server which includes windows and SQL Authentication. ,
Windows: Windows Authentication for SQL Server. ,
Undefined: Used for scenarios were the mode cannot be determined. ,
}
,
Required: False ,
}
enum ,
sqlServerEntraIdentity:
{
Description: Entra Authentication configuration for the SQL Server Instance. ,
Required: False ,
}
[
{
identityType:
{
Description: The method used for Entra authentication ,
Enum:
{
SystemAssignedManagedIdentity: System Assigned Managed Identity ,
UserAssignedManagedIdentity: User Assigned Managed Identity ,
}
,
Required: False ,
}
enum ,
clientId:
{
Description: The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerInstances_getTelemetry (new)
Description :  Retrieves SQL Server instance telemetry
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/getTelemetry
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
sqlServerInstanceTelemetryRequest:
{
Description: Contains the parameters to get SQL Server instance telemetry. ,
Required: True ,
}
{
datasetName:
{
Description: The name of the telemetry dataset to retrieve. ,
Required: True ,
}
string ,
startTime:
{
Description: The start time for the time range to fetch telemetry for. If not specified, the current time minus 1 hour is used. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the time range to fetch telemetry for. If not specified, the current time is used. ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
Description: The time granularity to fetch telemetry for. This is an ISO8601 duration. Examples: PT15M, PT1H, P1D ,
Format: duration ,
Required: False ,
}
string ,
aggregationType:
{
Description: The aggregation type to use for the numerical columns in the dataset. ,
Enum:
{
Average: No description available. ,
Minimum: No description available. ,
Maximum: No description available. ,
Sum: No description available. ,
Count: No description available. ,
}
,
Required: False ,
}
enum ,
databaseNames:
{
Description: The list of database names to return telemetry for. If not specified, telemetry for all databases will be aggregated and returned. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
columns:
{
Description: The columns of the result telemetry table for the SQL Server instance. ,
Required: True ,
}
[
{
name:
{
Description: The name of the telemetry column. ,
Required: False ,
}
string ,
type:
{
Description: The type of the telemetry column. ,
Enum:
{
bool: No description available. ,
datetime: No description available. ,
int: No description available. ,
long: No description available. ,
double: No description available. ,
string: No description available. ,
guid: No description available. ,
timespan: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
rows:
{
Description: A list of rows from the result telemetry table for the SQL Server instance. ,
Required: True ,
}
[
string ,
]
,
nextLink:
{
Description: The link to the next section of rows of the telemetry response for the SQL Server instance. Null if no more sections are available. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the operation status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerInstances_getBestPracticesAssessment (new)
Description :  Retrieves SQL best practices assessment results for the SQL Server instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/getBestPracticesAssessment
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
sqlServerInstanceBpaRequest:
{
Description: The request to fetch the SQL best practices assessment results. ,
Required: True ,
}
{
reportType:
{
Description: The report type that needs to be fetched. If not specified, the default is AssessmentSummary. ,
Enum:
{
AssessmentDataPoint: No description available. ,
AssessmentSummary: No description available. ,
}
,
Required: False ,
}
enum ,
reportId:
{
Description: The GUID of the report to return best practices assessment results for. If not specified, summaries for all reports will be returned. ,
Required: False ,
}
string ,
skipToken:
{
Description: The opaque token to use to skip to a specific page of the report. If not specified, the first page will be returned. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
columns:
{
Description: The SQL best practices assessment response columns. ,
Required: True ,
}
[
{
name:
{
Description: The name of the result column. ,
Required: False ,
}
string ,
type:
{
Description: The type of the result column. ,
Enum:
{
bool: No description available. ,
datetime: No description available. ,
int: No description available. ,
long: No description available. ,
double: No description available. ,
string: No description available. ,
guid: No description available. ,
timespan: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
rows:
{
Description: An array of results of the SQL best practices assessment response. ,
Required: True ,
}
[
string ,
]
,
nextLink:
{
Description: The link to the next page of the best practices assessment response for the SQL Server instance. Null, if no more pages are available. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the operation status. ,
}
string ,
azure-asyncoperation:
{
Description: The URL to retrieve the operation status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerInstances_runMigrationAssessment (new)
Description :  Runs migration assessment for SQL Server instance
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/runMigrationAssessment
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The unique identifier of the job. ,
Required: False ,
}
string ,
instanceName:
{
Description: The name of the SQL Server instance. ,
Required: False ,
}
string ,
jobStatus:
{
Description: The status of the job. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
jobException:
{
Description: The exception message if the job failed. ,
Required: False ,
}
string ,
backgroundJob:
{
Description: The background job details. ,
Required: False ,
}
{
state:
{
Description: The state of the background job. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Completed: No description available. ,
Faulted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
executionState:
{
Description: The execution state of the background job. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The start time of the background job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the background job. ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionStatus:
{
Description: The last execution status of the background job. ,
Enum:
{
Succeeded: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
Postponed: No description available. ,
Rescheduled: No description available. ,
}
,
Required: False ,
}
enum ,
lastExecutionTime:
{
Description: The last execution time of the background job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sequencerActions:
{
Description: The list of sequencer actions. ,
Required: False ,
}
[
{
actionId:
{
Description: The unique identifier of the sequencer action. ,
Required: False ,
}
string ,
state:
{
Description: The state of the sequencer action. ,
Enum:
{
NotStarted: No description available. ,
WaitingPredecessors: No description available. ,
ExecutingAction: No description available. ,
CreatingSuccessors: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
result:
{
Description: The result of the sequencer action. ,
Enum:
{
NotCompleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerInstances_runBestPracticesAssessment (new)
Description :  The request to run SQL best practices assessment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/runBestPracticesAssessment
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The unique identifier of the job. ,
Required: False ,
}
string ,
instanceName:
{
Description: The name of the SQL Server instance. ,
Required: False ,
}
string ,
jobStatus:
{
Description: The status of the job. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
jobException:
{
Description: The exception message if the job failed. ,
Required: False ,
}
string ,
backgroundJob:
{
Description: The background job details. ,
Required: False ,
}
{
state:
{
Description: The state of the background job. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Completed: No description available. ,
Faulted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
executionState:
{
Description: The execution state of the background job. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The start time of the background job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the background job. ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionStatus:
{
Description: The last execution status of the background job. ,
Enum:
{
Succeeded: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
Postponed: No description available. ,
Rescheduled: No description available. ,
}
,
Required: False ,
}
enum ,
lastExecutionTime:
{
Description: The last execution time of the background job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sequencerActions:
{
Description: The list of sequencer actions. ,
Required: False ,
}
[
{
actionId:
{
Description: The unique identifier of the sequencer action. ,
Required: False ,
}
string ,
state:
{
Description: The state of the sequencer action. ,
Enum:
{
NotStarted: No description available. ,
WaitingPredecessors: No description available. ,
ExecutingAction: No description available. ,
CreatingSuccessors: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
result:
{
Description: The result of the sequencer action. ,
Enum:
{
NotCompleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerInstances_getJobsStatus (new)
Description :  Gets jobs status details for sql arc resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/getJobsStatus
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
SqlServerInstanceJobsStatusRequest:
{
Description: Contains the parameters to get SQL Server instance agent jobs status. ,
Required: False ,
}
{
featureName:
{
Description: The name of the feature to retrieve the job status for. ,
Required: False ,
}
string ,
jobType:
{
Description: The type of the job to retrieve the status for. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
jobsStatus:
{
Description: The list of jobs status running on the SQL Server instance. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the job. ,
Required: False ,
}
string ,
instanceName:
{
Description: The name of the SQL Server instance. ,
Required: False ,
}
string ,
jobStatus:
{
Description: The status of the job. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
jobException:
{
Description: The exception message if the job failed. ,
Required: False ,
}
string ,
backgroundJob:
{
Description: The background job details. ,
Required: False ,
}
{
state:
{
Description: The state of the background job. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Completed: No description available. ,
Faulted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
executionState:
{
Description: The execution state of the background job. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The start time of the background job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the background job. ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionStatus:
{
Description: The last execution status of the background job. ,
Enum:
{
Succeeded: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
Postponed: No description available. ,
Rescheduled: No description available. ,
}
,
Required: False ,
}
enum ,
lastExecutionTime:
{
Description: The last execution time of the background job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sequencerActions:
{
Description: The list of sequencer actions. ,
Required: False ,
}
[
{
actionId:
{
Description: The unique identifier of the sequencer action. ,
Required: False ,
}
string ,
state:
{
Description: The state of the sequencer action. ,
Enum:
{
NotStarted: No description available. ,
WaitingPredecessors: No description available. ,
ExecutingAction: No description available. ,
CreatingSuccessors: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
result:
{
Description: The result of the sequencer action. ,
Enum:
{
NotCompleted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerInstances_preUpgrade (new)
Description :  Request Upgrade Permission before upgrading.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/preUpgrade
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: null ,
Required: False ,
}
{
version:
{
Description: SQL Server version. ,
Enum:
{
Unknown: No description available. ,
SQL Server 2012: No description available. ,
SQL Server 2014: No description available. ,
SQL Server 2016: No description available. ,
SQL Server 2017: No description available. ,
SQL Server 2019: No description available. ,
SQL Server 2022: No description available. ,
SQL Server 2025: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: SQL Server edition. ,
Enum:
{
Evaluation: No description available. ,
Enterprise: No description available. ,
Standard: No description available. ,
Web: No description available. ,
Developer: No description available. ,
Express: No description available. ,
Business Intelligence: No description available. ,
Standard Developer: No description available. ,
}
,
Required: False ,
}
enum ,
containerResourceId:
{
Description: ARM Resource id of the container resource (Azure Arc for Servers). ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
createTime:
{
Description: The time when the resource was created. ,
Required: False ,
}
string ,
vCore:
{
Description: The number of logical processors used by the SQL Server instance. ,
Required: False ,
}
string ,
cores:
{
Description: The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance. ,
Required: False ,
}
string ,
status:
{
Description: The cloud connectivity status. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Registered: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
patchLevel:
{
Description: SQL Server update level. ,
Required: False ,
}
string ,
collation:
{
Description: SQL Server collation. ,
Required: False ,
}
string ,
dbMasterKeyExists:
{
Description: Indicates whether database master key exists in SQL Server. ,
Required: False ,
}
boolean ,
isHadrEnabled:
{
Description: Indicates whether always On availability groups is enabled in SQL Server. ,
Required: False ,
}
boolean ,
traceFlags:
{
Description: An array of integers, where each value represents the enabled trace flags in SQL Server. ,
Required: False ,
}
[
integer ,
]
,
currentVersion:
{
Description: SQL Server current version. ,
Required: False ,
}
string ,
instanceName:
{
Description: SQL Server instance name. ,
Required: False ,
}
string ,
tcpDynamicPorts:
{
Description: Dynamic TCP ports used by SQL Server. ,
Required: False ,
}
string ,
tcpStaticPorts:
{
Description: Static TCP ports used by SQL Server. ,
Required: False ,
}
string ,
productId:
{
Description: SQL Server product ID. ,
Required: False ,
}
string ,
licenseType:
{
Description: SQL Server license type. ,
Enum:
{
Undefined: No description available. ,
Free: No description available. ,
HADR: No description available. ,
ServerCAL: No description available. ,
LicenseOnly: No description available. ,
PAYG: No description available. ,
Paid: No description available. ,
FabricCapacity: No description available. ,
}
,
Required: False ,
}
enum ,
azureDefenderStatusLastUpdated:
{
Description: Timestamp of last Azure Defender status update. ,
Format: date-time ,
Required: False ,
}
string ,
azureDefenderStatus:
{
Description: Status of Azure Defender. ,
Enum:
{
Protected: No description available. ,
Unprotected: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server resource. ,
Required: False ,
}
string ,
lastInventoryUploadTime:
{
Description: The time when last successful inventory upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUsageUploadTime:
{
Description: The time when last successful usage upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host for Azure Arc SQL Server ,
Enum:
{
Azure Virtual Machine: No description available. ,
Azure VMWare Virtual Machine: No description available. ,
Azure Kubernetes Service: No description available. ,
AWS VMWare Virtual Machine: No description available. ,
AWS Kubernetes Service: No description available. ,
GCP VMWare Virtual Machine: No description available. ,
GCP Kubernetes Service: No description available. ,
Container: No description available. ,
Virtual Machine: No description available. ,
Physical Server: No description available. ,
AWS Virtual Machine: No description available. ,
GCP Virtual Machine: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
alwaysOnRole:
{
Description: The role of the SQL Server, based on availability. ,
Enum:
{
None: No description available. ,
FailoverClusterInstance: No description available. ,
FailoverClusterNode: No description available. ,
AvailabilityGroupReplica: No description available. ,
}
,
Required: False ,
}
enum ,
databaseMirroringEndpoint:
{
Description: Database mirroring endpoint related properties. ,
Required: False ,
}
{
endpointName:
{
Description: Name of the database mirroring endpoint. ,
Required: False ,
}
string ,
role:
{
Description: Mirroring Role ,
Enum:
{
NONE: No description available. ,
PARTNER: No description available. ,
WITNESS: No description available. ,
ALL: No description available. ,
}
,
Required: False ,
}
enum ,
isEncryptionEnabled:
{
Description: Is Encryption enabled ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: Encryption Algorithm ,
Enum:
{
NONE: No description available. ,
RC4: No description available. ,
AES: No description available. ,
NONE, RC4: No description available. ,
NONE, AES: No description available. ,
RC4, AES: No description available. ,
AES, RC4: No description available. ,
NONE, RC4, AES: No description available. ,
NONE, AES, RC4: No description available. ,
}
,
Required: False ,
}
enum ,
connectionAuth:
{
Description: The type of connection authentication required for connections to this endpoint ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number that the endpoint is listening on. ,
Format: int32 ,
Required: False ,
}
integer ,
isDynamicPort:
{
Description: Is the port number dynamically assigned. ,
Required: False ,
}
boolean ,
ipAddress:
{
Description: Listener IP address. ,
Required: False ,
}
string ,
certificateName:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
certificateExpiryDate:
{
Description: The certificate expiry date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverCluster:
{
Description: Failover Cluster Instance properties. ,
Required: False ,
}
{
id:
{
Description: The GUID of the SQL Server's underlying Failover Cluster. ,
Required: False ,
}
string ,
networkName:
{
Description: The network name to connect to the SQL FCI. ,
Required: False ,
}
string ,
sqlInstanceIds:
{
Description: The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster. ,
Required: False ,
}
[
string ,
]
,
hostNames:
{
Description: The host names which are part of the SQL FCI resource group. ,
Required: False ,
}
[
string ,
]
,
hostIPAddresses:
{
Description: The IP addresses and subnet masks associated with the SQL Failover Cluster Instance on this host. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask ,
Required: False ,
}
string ,
}
,
]
,
}
,
backupPolicy:
{
Description: The backup profile for the SQL server. ,
Required: False ,
}
{
retentionPeriodDays:
{
Description: The retention period for all the databases in this managed instance. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupDays:
{
Description: The value indicating days between full backups. ,
Format: int32 ,
Required: False ,
}
integer ,
differentialBackupHours:
{
Description: The differential backup interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionLogBackupMinutes:
{
Description: The value indicating minutes between transaction log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
upgradeLockedUntil:
{
Description: Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty. ,
Format: date-time ,
Required: False ,
}
string ,
monitoring:
{
Description: The monitoring configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if monitoring is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
}
,
migration:
{
Description: Migration related configuration. ,
Required: False ,
}
{
assessment:
{
Description: Migration assessments related configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if migration assessment is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
assessmentUploadTime:
{
Description: The time when Migration Assessment Report upload was last performed. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: version of this migration assessment report - to be passed by the migration assessment engine. ,
Required: False ,
}
string ,
settings:
{
Description: Settings impacting the migration assessment computation - configurable with some default values if not set. ,
Required: False ,
}
{
targetLocation:
{
Description: The target location for Azure SQL SKU for migration. - default West US ,
Required: False ,
}
string ,
percentile:
{
Description: Indicate the percentile value for the performance sample. (Default is 95th percentile) ,
Format: float ,
Required: False ,
}
number ,
lookbackPeriodInDays:
{
Description: How far back to check the performance data - default is 30 (days). ,
Format: int32 ,
Required: False ,
}
number ,
strategy:
{
Description: Minimize cost or Migrate to PaaS. - to evaluate based on the recommended strategy ,
Required: False ,
}
string ,
currency:
{
Description: currency to calculate prices - default USD. ,
Required: False ,
}
string ,
discountPercentage:
{
Description: flat discount percentage to apply for the price - default 0 ,
Format: float ,
Required: False ,
}
number ,
costOptions:
{
Description: Selected cost option value. ,
Required: False ,
}
{
computeAndStorageCostOption:
{
Description: selected cost saving option e.g. With1YearASPAndDevTest. ,
Required: False ,
}
string ,
sqlLicenseCostOption:
{
Description: With Azure Hybrid Benefit(AHB) or not for SQL. ,
Required: False ,
}
string ,
windowsLicenseCostOption:
{
Description: With Azure Hybrid Benefit(AHB) or not for Windows. ,
Required: False ,
}
string ,
}
,
}
,
serverAssessments:
{
Description: Issues and warnings impacting the migration of SQL Server instance to particular Azure Migration Target. ,
Required: False ,
}
[
{
appliesToMigrationTargetPlatform:
{
Required: False ,
}
string ,
featureId:
{
Required: False ,
}
string ,
impactedObjects:
{
Required: False ,
}
[
{
impactDetail:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
objectType:
{
Required: False ,
}
string ,
}
,
]
,
issueCategory:
{
Required: False ,
}
string ,
moreInformation:
{
Required: False ,
}
string ,
}
,
]
,
skuRecommendationResults:
{
Description: SKU Recommendation results for Azure migration targets for SQL Server. ,
Required: False ,
}
{
azureSqlDatabase:
{
Description: SKU Recommendation results for Azure SQL Database. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: maximum storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The maximum storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The maximum throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlManagedInstance:
{
Description: SKU Recommendation results for Azure SQL Managed Instance. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: maximum storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The maximum storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The maximum throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlVirtualMachine:
{
Description: SKU Recommendation results for Azure SQL Virtual Machine. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
availableVmSkus:
{
Description: Available VM SKUs for the Azure SQL Virtual Machine. ,
Required: False ,
}
[
string ,
]
,
virtualMachineFamily:
{
Description: The virtual machine family of the target SKU. ,
Required: False ,
}
string ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
virtualMachineSize:
{
Description: size parameters for VM size. ,
Required: False ,
}
{
virtualMachineFamily:
{
Description: Virtual Machine Family, for example : standardMSFamily ,
Required: False ,
}
string ,
sizeName:
{
Description: VM Size, for example : M64ls ,
Required: False ,
}
string ,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
azureSkuName:
{
Description: Virtual Machine SKU name,: Eg : Standard_F16s. ,
Required: False ,
}
string ,
vCPUsAvailable:
{
Description: Available vCores. This can be less than the vCores in the Constrained vCPU VM Sizes. ,
Format: int32 ,
Required: False ,
}
number ,
maxNetworkInterfaces:
{
Description: maximum network interfaces. ,
Format: int32 ,
Required: False ,
}
number ,
}
,
dataDiskSizes:
{
Description: Data disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
logDiskSizes:
{
Description: Log disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
tempDbDiskSizes:
{
Description: temp db disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}
,
impactedObjectsSummary:
{
Description: Represents a summary of migration readiness issues/warnings per feature type for Azure SQL DB and SQL MI targets ,
Required: False ,
}
{
azureSqlDatabase:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
azureSqlManagedInstance:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
bestPracticesAssessment:
{
Description: The configuration related to SQL best practices assessment. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if SQL best practices assessment is enabled for the SQL Server instance. ,
Required: False ,
}
boolean ,
schedule:
{
Description: The scheduling configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether scheduling is enabled. ,
Required: False ,
}
boolean ,
cronTrigger:
{
Description: The cron trigger configuration. ,
Required: False ,
}
{
startTime:
{
Description: Indicates the start time for the trigger. The default value is the time at which the trigger was created. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone in which the trigger is scheduled. ,
Required: False ,
}
string ,
expression:
{
Description: A cron string representing a CronTab expression. A crontab expression is a very compact way to express a recurring schedule with the following format: '{minutes} {hours} {days} {months} {days-of-week}'. ,
Required: False ,
}
string ,
}
,
}
,
}
,
clientConnection:
{
Description: Client connection related configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if client connection is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
}
,
serviceType:
{
Description: Indicates if the resource represents a SQL Server engine or a SQL Server component service installed on the host. ,
Enum:
{
Engine: SQL Server Database Services. ,
SSRS: SQL Server Reporting Services. ,
SSAS: SQL Server Analysis Services. ,
SSIS: SQL Server Integration Services. ,
PBIRS: Power BI Report Server. ,
}
,
Required: False ,
}
enum ,
maxServerMemoryMB:
{
Description: maximum server memory (MB) value configured for this instance. ,
Format: int64 ,
Required: False ,
}
integer ,
isMicrosoftPkiCertTrustConfigured:
{
Description: Indicates whether Microsoft PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. ,
Required: False ,
}
boolean ,
isDigiCertPkiCertTrustConfigured:
{
Description: Indicates whether DigiCert PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. ,
Required: False ,
}
boolean ,
authentication:
{
Description: Authentication related configuration for the SQL Server Instance. ,
Required: False ,
}
{
mode:
{
Description: Mode of authentication in SqlServer. ,
Enum:
{
Mixed: Mixed mode authentication for SQL Server which includes windows and SQL Authentication. ,
Windows: Windows Authentication for SQL Server. ,
Undefined: Used for scenarios were the mode cannot be determined. ,
}
,
Required: False ,
}
enum ,
sqlServerEntraIdentity:
{
Description: Entra Authentication configuration for the SQL Server Instance. ,
Required: False ,
}
[
{
identityType:
{
Description: The method used for Entra authentication ,
Enum:
{
SystemAssignedManagedIdentity: System Assigned Managed Identity ,
UserAssignedManagedIdentity: User Assigned Managed Identity ,
}
,
Required: False ,
}
enum ,
clientId:
{
Description: The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerInstances_postUpgrade (new)
Description :  Clean up after upgrading.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/postUpgrade
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: null ,
Required: False ,
}
{
version:
{
Description: SQL Server version. ,
Enum:
{
Unknown: No description available. ,
SQL Server 2012: No description available. ,
SQL Server 2014: No description available. ,
SQL Server 2016: No description available. ,
SQL Server 2017: No description available. ,
SQL Server 2019: No description available. ,
SQL Server 2022: No description available. ,
SQL Server 2025: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: SQL Server edition. ,
Enum:
{
Evaluation: No description available. ,
Enterprise: No description available. ,
Standard: No description available. ,
Web: No description available. ,
Developer: No description available. ,
Express: No description available. ,
Business Intelligence: No description available. ,
Standard Developer: No description available. ,
}
,
Required: False ,
}
enum ,
containerResourceId:
{
Description: ARM Resource id of the container resource (Azure Arc for Servers). ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
createTime:
{
Description: The time when the resource was created. ,
Required: False ,
}
string ,
vCore:
{
Description: The number of logical processors used by the SQL Server instance. ,
Required: False ,
}
string ,
cores:
{
Description: The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance. ,
Required: False ,
}
string ,
status:
{
Description: The cloud connectivity status. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Registered: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
patchLevel:
{
Description: SQL Server update level. ,
Required: False ,
}
string ,
collation:
{
Description: SQL Server collation. ,
Required: False ,
}
string ,
dbMasterKeyExists:
{
Description: Indicates whether database master key exists in SQL Server. ,
Required: False ,
}
boolean ,
isHadrEnabled:
{
Description: Indicates whether always On availability groups is enabled in SQL Server. ,
Required: False ,
}
boolean ,
traceFlags:
{
Description: An array of integers, where each value represents the enabled trace flags in SQL Server. ,
Required: False ,
}
[
integer ,
]
,
currentVersion:
{
Description: SQL Server current version. ,
Required: False ,
}
string ,
instanceName:
{
Description: SQL Server instance name. ,
Required: False ,
}
string ,
tcpDynamicPorts:
{
Description: Dynamic TCP ports used by SQL Server. ,
Required: False ,
}
string ,
tcpStaticPorts:
{
Description: Static TCP ports used by SQL Server. ,
Required: False ,
}
string ,
productId:
{
Description: SQL Server product ID. ,
Required: False ,
}
string ,
licenseType:
{
Description: SQL Server license type. ,
Enum:
{
Undefined: No description available. ,
Free: No description available. ,
HADR: No description available. ,
ServerCAL: No description available. ,
LicenseOnly: No description available. ,
PAYG: No description available. ,
Paid: No description available. ,
FabricCapacity: No description available. ,
}
,
Required: False ,
}
enum ,
azureDefenderStatusLastUpdated:
{
Description: Timestamp of last Azure Defender status update. ,
Format: date-time ,
Required: False ,
}
string ,
azureDefenderStatus:
{
Description: Status of Azure Defender. ,
Enum:
{
Protected: No description available. ,
Unprotected: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server resource. ,
Required: False ,
}
string ,
lastInventoryUploadTime:
{
Description: The time when last successful inventory upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUsageUploadTime:
{
Description: The time when last successful usage upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host for Azure Arc SQL Server ,
Enum:
{
Azure Virtual Machine: No description available. ,
Azure VMWare Virtual Machine: No description available. ,
Azure Kubernetes Service: No description available. ,
AWS VMWare Virtual Machine: No description available. ,
AWS Kubernetes Service: No description available. ,
GCP VMWare Virtual Machine: No description available. ,
GCP Kubernetes Service: No description available. ,
Container: No description available. ,
Virtual Machine: No description available. ,
Physical Server: No description available. ,
AWS Virtual Machine: No description available. ,
GCP Virtual Machine: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
alwaysOnRole:
{
Description: The role of the SQL Server, based on availability. ,
Enum:
{
None: No description available. ,
FailoverClusterInstance: No description available. ,
FailoverClusterNode: No description available. ,
AvailabilityGroupReplica: No description available. ,
}
,
Required: False ,
}
enum ,
databaseMirroringEndpoint:
{
Description: Database mirroring endpoint related properties. ,
Required: False ,
}
{
endpointName:
{
Description: Name of the database mirroring endpoint. ,
Required: False ,
}
string ,
role:
{
Description: Mirroring Role ,
Enum:
{
NONE: No description available. ,
PARTNER: No description available. ,
WITNESS: No description available. ,
ALL: No description available. ,
}
,
Required: False ,
}
enum ,
isEncryptionEnabled:
{
Description: Is Encryption enabled ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: Encryption Algorithm ,
Enum:
{
NONE: No description available. ,
RC4: No description available. ,
AES: No description available. ,
NONE, RC4: No description available. ,
NONE, AES: No description available. ,
RC4, AES: No description available. ,
AES, RC4: No description available. ,
NONE, RC4, AES: No description available. ,
NONE, AES, RC4: No description available. ,
}
,
Required: False ,
}
enum ,
connectionAuth:
{
Description: The type of connection authentication required for connections to this endpoint ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number that the endpoint is listening on. ,
Format: int32 ,
Required: False ,
}
integer ,
isDynamicPort:
{
Description: Is the port number dynamically assigned. ,
Required: False ,
}
boolean ,
ipAddress:
{
Description: Listener IP address. ,
Required: False ,
}
string ,
certificateName:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
certificateExpiryDate:
{
Description: The certificate expiry date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverCluster:
{
Description: Failover Cluster Instance properties. ,
Required: False ,
}
{
id:
{
Description: The GUID of the SQL Server's underlying Failover Cluster. ,
Required: False ,
}
string ,
networkName:
{
Description: The network name to connect to the SQL FCI. ,
Required: False ,
}
string ,
sqlInstanceIds:
{
Description: The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster. ,
Required: False ,
}
[
string ,
]
,
hostNames:
{
Description: The host names which are part of the SQL FCI resource group. ,
Required: False ,
}
[
string ,
]
,
hostIPAddresses:
{
Description: The IP addresses and subnet masks associated with the SQL Failover Cluster Instance on this host. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask ,
Required: False ,
}
string ,
}
,
]
,
}
,
backupPolicy:
{
Description: The backup profile for the SQL server. ,
Required: False ,
}
{
retentionPeriodDays:
{
Description: The retention period for all the databases in this managed instance. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupDays:
{
Description: The value indicating days between full backups. ,
Format: int32 ,
Required: False ,
}
integer ,
differentialBackupHours:
{
Description: The differential backup interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionLogBackupMinutes:
{
Description: The value indicating minutes between transaction log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
upgradeLockedUntil:
{
Description: Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty. ,
Format: date-time ,
Required: False ,
}
string ,
monitoring:
{
Description: The monitoring configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if monitoring is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
}
,
migration:
{
Description: Migration related configuration. ,
Required: False ,
}
{
assessment:
{
Description: Migration assessments related configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if migration assessment is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
assessmentUploadTime:
{
Description: The time when Migration Assessment Report upload was last performed. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: version of this migration assessment report - to be passed by the migration assessment engine. ,
Required: False ,
}
string ,
settings:
{
Description: Settings impacting the migration assessment computation - configurable with some default values if not set. ,
Required: False ,
}
{
targetLocation:
{
Description: The target location for Azure SQL SKU for migration. - default West US ,
Required: False ,
}
string ,
percentile:
{
Description: Indicate the percentile value for the performance sample. (Default is 95th percentile) ,
Format: float ,
Required: False ,
}
number ,
lookbackPeriodInDays:
{
Description: How far back to check the performance data - default is 30 (days). ,
Format: int32 ,
Required: False ,
}
number ,
strategy:
{
Description: Minimize cost or Migrate to PaaS. - to evaluate based on the recommended strategy ,
Required: False ,
}
string ,
currency:
{
Description: currency to calculate prices - default USD. ,
Required: False ,
}
string ,
discountPercentage:
{
Description: flat discount percentage to apply for the price - default 0 ,
Format: float ,
Required: False ,
}
number ,
costOptions:
{
Description: Selected cost option value. ,
Required: False ,
}
{
computeAndStorageCostOption:
{
Description: selected cost saving option e.g. With1YearASPAndDevTest. ,
Required: False ,
}
string ,
sqlLicenseCostOption:
{
Description: With Azure Hybrid Benefit(AHB) or not for SQL. ,
Required: False ,
}
string ,
windowsLicenseCostOption:
{
Description: With Azure Hybrid Benefit(AHB) or not for Windows. ,
Required: False ,
}
string ,
}
,
}
,
serverAssessments:
{
Description: Issues and warnings impacting the migration of SQL Server instance to particular Azure Migration Target. ,
Required: False ,
}
[
{
appliesToMigrationTargetPlatform:
{
Required: False ,
}
string ,
featureId:
{
Required: False ,
}
string ,
impactedObjects:
{
Required: False ,
}
[
{
impactDetail:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
objectType:
{
Required: False ,
}
string ,
}
,
]
,
issueCategory:
{
Required: False ,
}
string ,
moreInformation:
{
Required: False ,
}
string ,
}
,
]
,
skuRecommendationResults:
{
Description: SKU Recommendation results for Azure migration targets for SQL Server. ,
Required: False ,
}
{
azureSqlDatabase:
{
Description: SKU Recommendation results for Azure SQL Database. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: maximum storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The maximum storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The maximum throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlManagedInstance:
{
Description: SKU Recommendation results for Azure SQL Managed Instance. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: maximum storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The maximum storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The maximum throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlVirtualMachine:
{
Description: SKU Recommendation results for Azure SQL Virtual Machine. ,
Required: False ,
}
{
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfServerBlockerIssues:
{
Description: Number of blocker issues to fix before migrating to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
availableVmSkus:
{
Description: Available VM SKUs for the Azure SQL Virtual Machine. ,
Required: False ,
}
[
string ,
]
,
virtualMachineFamily:
{
Description: The virtual machine family of the target SKU. ,
Required: False ,
}
string ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
virtualMachineSize:
{
Description: size parameters for VM size. ,
Required: False ,
}
{
virtualMachineFamily:
{
Description: Virtual Machine Family, for example : standardMSFamily ,
Required: False ,
}
string ,
sizeName:
{
Description: VM Size, for example : M64ls ,
Required: False ,
}
string ,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
azureSkuName:
{
Description: Virtual Machine SKU name,: Eg : Standard_F16s. ,
Required: False ,
}
string ,
vCPUsAvailable:
{
Description: Available vCores. This can be less than the vCores in the Constrained vCPU VM Sizes. ,
Format: int32 ,
Required: False ,
}
number ,
maxNetworkInterfaces:
{
Description: maximum network interfaces. ,
Format: int32 ,
Required: False ,
}
number ,
}
,
dataDiskSizes:
{
Description: Data disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
logDiskSizes:
{
Description: Log disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
tempDbDiskSizes:
{
Description: temp db disk sizes. ,
Required: False ,
}
[
{
diskType:
{
Description: Type of managed disk. ,
Required: False ,
}
string ,
redundancy:
{
Description: Redundancy option. ,
Required: False ,
}
string ,
size:
{
Description: Size of the managed disk - e.g. P30, P40. ,
Required: False ,
}
string ,
caching:
{
Description: Caching configuration - e.g. read only caching ,
Required: False ,
}
string ,
maxSizeInGib:
{
Description: maximum disk size in GiB. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputInMbps:
{
Description: maximum throughput in MB/s. ,
Format: float ,
Required: False ,
}
number ,
maxIops:
{
Description: maximum number of input/output operations per second (IOPS). ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}
,
impactedObjectsSummary:
{
Description: Represents a summary of migration readiness issues/warnings per feature type for Azure SQL DB and SQL MI targets ,
Required: False ,
}
{
azureSqlDatabase:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
azureSqlManagedInstance:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
bestPracticesAssessment:
{
Description: The configuration related to SQL best practices assessment. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if SQL best practices assessment is enabled for the SQL Server instance. ,
Required: False ,
}
boolean ,
schedule:
{
Description: The scheduling configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether scheduling is enabled. ,
Required: False ,
}
boolean ,
cronTrigger:
{
Description: The cron trigger configuration. ,
Required: False ,
}
{
startTime:
{
Description: Indicates the start time for the trigger. The default value is the time at which the trigger was created. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone in which the trigger is scheduled. ,
Required: False ,
}
string ,
expression:
{
Description: A cron string representing a CronTab expression. A crontab expression is a very compact way to express a recurring schedule with the following format: '{minutes} {hours} {days} {months} {days-of-week}'. ,
Required: False ,
}
string ,
}
,
}
,
}
,
clientConnection:
{
Description: Client connection related configuration. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if client connection is enabled for this SQL Server instance. ,
Required: False ,
}
boolean ,
}
,
serviceType:
{
Description: Indicates if the resource represents a SQL Server engine or a SQL Server component service installed on the host. ,
Enum:
{
Engine: SQL Server Database Services. ,
SSRS: SQL Server Reporting Services. ,
SSAS: SQL Server Analysis Services. ,
SSIS: SQL Server Integration Services. ,
PBIRS: Power BI Report Server. ,
}
,
Required: False ,
}
enum ,
maxServerMemoryMB:
{
Description: maximum server memory (MB) value configured for this instance. ,
Format: int64 ,
Required: False ,
}
integer ,
isMicrosoftPkiCertTrustConfigured:
{
Description: Indicates whether Microsoft PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. ,
Required: False ,
}
boolean ,
isDigiCertPkiCertTrustConfigured:
{
Description: Indicates whether DigiCert PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. ,
Required: False ,
}
boolean ,
authentication:
{
Description: Authentication related configuration for the SQL Server Instance. ,
Required: False ,
}
{
mode:
{
Description: Mode of authentication in SqlServer. ,
Enum:
{
Mixed: Mixed mode authentication for SQL Server which includes windows and SQL Authentication. ,
Windows: Windows Authentication for SQL Server. ,
Undefined: Used for scenarios were the mode cannot be determined. ,
}
,
Required: False ,
}
enum ,
sqlServerEntraIdentity:
{
Description: Entra Authentication configuration for the SQL Server Instance. ,
Required: False ,
}
[
{
identityType:
{
Description: The method used for Entra authentication ,
Enum:
{
SystemAssignedManagedIdentity: System Assigned Managed Identity ,
UserAssignedManagedIdentity: User Assigned Managed Identity ,
}
,
Required: False ,
}
enum ,
clientId:
{
Description: The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerInstances_runManagedInstanceLinkAssessment (new)
Description :  Runs Managed Instance Link assessment for SQL Server instance
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/runManagedInstanceLinkAssessment
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
sqlServerInstanceManagedInstanceLinkAssessmentRequest:
{
Description: Contains the parameters to run SQL Server instance MI link assessment. ,
Required: True ,
}
{
azureManagedInstanceResourceId:
{
Description: The Azure SQL Managed Instance resource ID to link with the SQL Server instance. ,
Format: arm-id ,
Required: True ,
}
string ,
azureManagedInstanceRole:
{
Description: The role of managed instance in a distributed availability group, can be Primary or Secondary. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
databaseNames:
{
Description: An array of strings, where each value represents the name of a database to be replicated to the Azure SQL Managed Instance. ,
Required: True ,
}
[
string ,
]
,
availabilityGroupName:
{
Description: The name of the availability group to be used for the database replication. ,
Required: True ,
}
string ,
distributedAvailabilityGroupName:
{
Description: The name of the DAG to be used for the database replication. Also referred to as Link Name. ,
Required: True ,
}
string ,
assessmentCategories:
{
Description: An array of strings, where each value represents the category of the assessment to be run. If this field is not provided, all assessment categories will be run. ,
Required: False ,
}
[
string ,
]
,
sqlServerIpAddress:
{
Description: The IP address of the SQL Server instance. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
assessments:
{
Description: The list of the results for MI Link assessment. ,
Required: False ,
}
[
{
name:
{
Description: The name of the requirement. ,
Required: False ,
}
string ,
category:
{
Description: Validation category for the MI Link prerequisites assessment. ,
Enum:
{
SqlInstance: Assessments of the given instance on the on-premise SQL Server (box). ,
SqlInstanceDatabase: Assessments of the database(s) on the given instance on the on-premise SQL Server (box). ,
ManagedInstance: Assessments of the Managed Instance. ,
ManagedInstanceDatabase: Assessments of the database(s) on the Managed Instance. ,
ManagedInstanceCrossValidation: Assessments that use data from both the Managed Instance and the given instance of the on-premise SQL Server (box) for the validations. ,
Certificates: Assessments of the necessary certificates configuration. ,
BoxToMiNetworkConnectivity: Assessment of network connectivity from the on-premise SQL Server (box) to the Managed Instance. ,
MiToBoxNetworkConnectivity: Assessments of network connectivity from the Managed Instance to the on-premise SQL Server (box). ,
SqlInstanceAg: Assessments of the chosen Availability Group. ,
DagCrossValidation: Assessments of the chosen Distributed Availability Group. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the requirement. ,
Enum:
{
Success: No description available. ,
Warning: No description available. ,
Failure: No description available. ,
}
,
Required: False ,
}
enum ,
information:
{
Description: The information text about requirement. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional details about the check, including any recommended actions. ,
Required: False ,
}
string ,
failingDbs:
{
Description: List of names of databases that are failing the given assessment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The URL to retrieve the operation status. ,
}
string ,
azure-asyncoperation:
{
Description: The URL to retrieve the operation status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerLicenses_List (new)
Description :  List sqlServerLicense resources in the subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlServerLicenses
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: SQL Server license properties ,
Required: True ,
}
{
billingPlan:
{
Description: SQL Server license type. ,
Enum:
{
PAYG: No description available. ,
Paid: No description available. ,
}
,
Required: True ,
}
enum ,
physicalCores:
{
Description: The number of total cores of the license covers. ,
Format: int32 ,
Required: True ,
}
integer ,
licenseCategory:
{
Description: This property represents the choice between SQL Server Core and ESU licenses. ,
Enum:
{
Core: No description available. ,
}
,
Required: True ,
}
enum ,
activationState:
{
Description: The activation state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: True ,
}
enum ,
scopeType:
{
Description: The Azure scope to which the license will apply. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
ResourceGroup: No description available. ,
}
,
Required: True ,
}
enum ,
lastActivatedAt:
{
Description: The timestamp of the most recent activation of the SqlServerLicense. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeactivatedAt:
{
Description: The timestamp of the most recent deactivation of the SqlServerLicense. ,
Format: date-time ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId the SQL Server license resource subscription resides in. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerLicenses_ListByResourceGroup (new)
Description :  Gets all sqlServerLicenses in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerLicenses
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: SQL Server license properties ,
Required: True ,
}
{
billingPlan:
{
Description: SQL Server license type. ,
Enum:
{
PAYG: No description available. ,
Paid: No description available. ,
}
,
Required: True ,
}
enum ,
physicalCores:
{
Description: The number of total cores of the license covers. ,
Format: int32 ,
Required: True ,
}
integer ,
licenseCategory:
{
Description: This property represents the choice between SQL Server Core and ESU licenses. ,
Enum:
{
Core: No description available. ,
}
,
Required: True ,
}
enum ,
activationState:
{
Description: The activation state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: True ,
}
enum ,
scopeType:
{
Description: The Azure scope to which the license will apply. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
ResourceGroup: No description available. ,
}
,
Required: True ,
}
enum ,
lastActivatedAt:
{
Description: The timestamp of the most recent activation of the SqlServerLicense. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeactivatedAt:
{
Description: The timestamp of the most recent deactivation of the SqlServerLicense. ,
Format: date-time ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId the SQL Server license resource subscription resides in. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerLicenses_Get (new)
Description :  Retrieves a SQL Server license resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerLicenses/{sqlServerLicenseName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerLicenseName:
{
Description: Name of SQL Server License ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SQL Server license properties ,
Required: True ,
}
{
billingPlan:
{
Description: SQL Server license type. ,
Enum:
{
PAYG: No description available. ,
Paid: No description available. ,
}
,
Required: True ,
}
enum ,
physicalCores:
{
Description: The number of total cores of the license covers. ,
Format: int32 ,
Required: True ,
}
integer ,
licenseCategory:
{
Description: This property represents the choice between SQL Server Core and ESU licenses. ,
Enum:
{
Core: No description available. ,
}
,
Required: True ,
}
enum ,
activationState:
{
Description: The activation state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: True ,
}
enum ,
scopeType:
{
Description: The Azure scope to which the license will apply. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
ResourceGroup: No description available. ,
}
,
Required: True ,
}
enum ,
lastActivatedAt:
{
Description: The timestamp of the most recent activation of the SqlServerLicense. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeactivatedAt:
{
Description: The timestamp of the most recent deactivation of the SqlServerLicense. ,
Format: date-time ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId the SQL Server license resource subscription resides in. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerLicenses_Create (new)
Description :  Creates or replaces a SQL Server license resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerLicenses/{sqlServerLicenseName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerLicenseName:
{
Description: Name of SQL Server License ,
Required: True ,
}
string ,
sqlServerLicense:
{
Description: The SQL Server license to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: SQL Server license properties ,
Required: True ,
}
{
billingPlan:
{
Description: SQL Server license type. ,
Enum:
{
PAYG: No description available. ,
Paid: No description available. ,
}
,
Required: True ,
}
enum ,
physicalCores:
{
Description: The number of total cores of the license covers. ,
Format: int32 ,
Required: True ,
}
integer ,
licenseCategory:
{
Description: This property represents the choice between SQL Server Core and ESU licenses. ,
Enum:
{
Core: No description available. ,
}
,
Required: True ,
}
enum ,
activationState:
{
Description: The activation state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: True ,
}
enum ,
scopeType:
{
Description: The Azure scope to which the license will apply. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
ResourceGroup: No description available. ,
}
,
Required: True ,
}
enum ,
lastActivatedAt:
{
Description: The timestamp of the most recent activation of the SqlServerLicense. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeactivatedAt:
{
Description: The timestamp of the most recent deactivation of the SqlServerLicense. ,
Format: date-time ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId the SQL Server license resource subscription resides in. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SQL Server license properties ,
Required: True ,
}
{
billingPlan:
{
Description: SQL Server license type. ,
Enum:
{
PAYG: No description available. ,
Paid: No description available. ,
}
,
Required: True ,
}
enum ,
physicalCores:
{
Description: The number of total cores of the license covers. ,
Format: int32 ,
Required: True ,
}
integer ,
licenseCategory:
{
Description: This property represents the choice between SQL Server Core and ESU licenses. ,
Enum:
{
Core: No description available. ,
}
,
Required: True ,
}
enum ,
activationState:
{
Description: The activation state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: True ,
}
enum ,
scopeType:
{
Description: The Azure scope to which the license will apply. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
ResourceGroup: No description available. ,
}
,
Required: True ,
}
enum ,
lastActivatedAt:
{
Description: The timestamp of the most recent activation of the SqlServerLicense. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeactivatedAt:
{
Description: The timestamp of the most recent deactivation of the SqlServerLicense. ,
Format: date-time ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId the SQL Server license resource subscription resides in. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: SQL Server license properties ,
Required: True ,
}
{
billingPlan:
{
Description: SQL Server license type. ,
Enum:
{
PAYG: No description available. ,
Paid: No description available. ,
}
,
Required: True ,
}
enum ,
physicalCores:
{
Description: The number of total cores of the license covers. ,
Format: int32 ,
Required: True ,
}
integer ,
licenseCategory:
{
Description: This property represents the choice between SQL Server Core and ESU licenses. ,
Enum:
{
Core: No description available. ,
}
,
Required: True ,
}
enum ,
activationState:
{
Description: The activation state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: True ,
}
enum ,
scopeType:
{
Description: The Azure scope to which the license will apply. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
ResourceGroup: No description available. ,
}
,
Required: True ,
}
enum ,
lastActivatedAt:
{
Description: The timestamp of the most recent activation of the SqlServerLicense. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeactivatedAt:
{
Description: The timestamp of the most recent deactivation of the SqlServerLicense. ,
Format: date-time ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId the SQL Server license resource subscription resides in. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerLicenses_Delete (new)
Description :  Deletes a SQL Server license resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerLicenses/{sqlServerLicenseName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerLicenseName:
{
Description: Name of SQL Server License ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (204)

{}
SqlServerLicenses_Update (new)
Description :  Updates a SQL Server license resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerLicenses/{sqlServerLicenseName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerLicenseName:
{
Description: Name of SQL Server License ,
Required: True ,
}
string ,
parameters:
{
Description: The SQL Server license. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: null ,
Required: False ,
}
{
billingPlan:
{
Description: SQL Server license type. ,
Enum:
{
PAYG: No description available. ,
Paid: No description available. ,
}
,
Required: False ,
}
enum ,
physicalCores:
{
Description: The number of total cores of the license covers. ,
Format: int32 ,
Required: False ,
}
integer ,
licenseCategory:
{
Description: This property represents the choice between SQL Server Core and ESU licenses. ,
Enum:
{
Core: No description available. ,
}
,
Required: False ,
}
enum ,
activationState:
{
Description: The activation state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
scopeType:
{
Description: The Azure scope to which the license will apply. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
ResourceGroup: No description available. ,
}
,
Required: False ,
}
enum ,
lastActivatedAt:
{
Description: The timestamp of the most recent activation of the SqlServerLicense. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeactivatedAt:
{
Description: The timestamp of the most recent deactivation of the SqlServerLicense. ,
Format: date-time ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId the SQL Server license resource subscription resides in. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SQL Server license properties ,
Required: True ,
}
{
billingPlan:
{
Description: SQL Server license type. ,
Enum:
{
PAYG: No description available. ,
Paid: No description available. ,
}
,
Required: True ,
}
enum ,
physicalCores:
{
Description: The number of total cores of the license covers. ,
Format: int32 ,
Required: True ,
}
integer ,
licenseCategory:
{
Description: This property represents the choice between SQL Server Core and ESU licenses. ,
Enum:
{
Core: No description available. ,
}
,
Required: True ,
}
enum ,
activationState:
{
Description: The activation state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: True ,
}
enum ,
scopeType:
{
Description: The Azure scope to which the license will apply. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
ResourceGroup: No description available. ,
}
,
Required: True ,
}
enum ,
lastActivatedAt:
{
Description: The timestamp of the most recent activation of the SqlServerLicense. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeactivatedAt:
{
Description: The timestamp of the most recent deactivation of the SqlServerLicense. ,
Format: date-time ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId the SQL Server license resource subscription resides in. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataControllers_ListInSubscription (new)
Description :  List dataController resources in the subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/dataControllers
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The data controller's properties ,
Required: True ,
}
{
infrastructure:
{
Description: The infrastructure the data controller is running on. ,
Enum:
{
azure: No description available. ,
gcp: No description available. ,
aws: No description available. ,
alibaba: No description available. ,
onpremises: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
onPremiseProperty:
{
Description: Properties from the Kubernetes data controller ,
Required: False ,
}
{
id:
{
Description: A globally unique ID identifying the associated Kubernetes cluster ,
Format: uuid ,
Required: True ,
}
string ,
publicSigningKey:
{
Description: Certificate that contains the Kubernetes cluster public key used to verify signing ,
Required: True ,
}
string ,
signingCertificateThumbprint:
{
Description: Unique thumbprint returned to customer to verify the certificate being uploaded ,
Required: False ,
}
string ,
}
,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
object ,
uploadWatermark:
{
Description: Properties on upload watermark. Mostly timestamp for each upload data type ,
Required: False ,
}
{
metrics:
{
Description: Last uploaded date for metrics from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
logs:
{
Description: Last uploaded date for logs from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
usages:
{
Description: Last uploaded date for usages from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
basicLoginInformation:
{
Description: Deprecated. Azure Arc Data Services data controller no longer expose any endpoint. All traffic are exposed through Kubernetes native API. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
metricsDashboardCredential:
{
Description: Login credential for metrics dashboard on the Kubernetes cluster. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
logsDashboardCredential:
{
Description: Login credential for logs dashboard on the Kubernetes cluster. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
logAnalyticsWorkspaceConfig:
{
Description: Log analytics workspace id and primary key ,
Required: False ,
}
{
workspaceId:
{
Description: Azure Log Analytics workspace ID ,
Format: uuid ,
Required: False ,
}
string ,
primaryKey:
{
Description: Primary key of the workspace ,
Required: False ,
}
string ,
}
,
uploadServicePrincipal:
{
Description: Deprecated. Service principal is deprecated in favor of Arc Kubernetes service extension managed identity. ,
Required: False ,
}
{
clientId:
{
Description: Client ID of the service principal for uploading data. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the service principal. ,
Format: uuid ,
Required: False ,
}
string ,
authority:
{
Description: Authority for the service principal. Example: https://login.microsoftonline.com/ ,
Required: False ,
}
string ,
clientSecret:
{
Description: Secret of the service principal ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc Data Controller resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. ,
Required: False ,
}
string ,
extensionId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataControllers_ListInGroup (new)
Description :  List dataController resources in the resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The data controller's properties ,
Required: True ,
}
{
infrastructure:
{
Description: The infrastructure the data controller is running on. ,
Enum:
{
azure: No description available. ,
gcp: No description available. ,
aws: No description available. ,
alibaba: No description available. ,
onpremises: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
onPremiseProperty:
{
Description: Properties from the Kubernetes data controller ,
Required: False ,
}
{
id:
{
Description: A globally unique ID identifying the associated Kubernetes cluster ,
Format: uuid ,
Required: True ,
}
string ,
publicSigningKey:
{
Description: Certificate that contains the Kubernetes cluster public key used to verify signing ,
Required: True ,
}
string ,
signingCertificateThumbprint:
{
Description: Unique thumbprint returned to customer to verify the certificate being uploaded ,
Required: False ,
}
string ,
}
,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
object ,
uploadWatermark:
{
Description: Properties on upload watermark. Mostly timestamp for each upload data type ,
Required: False ,
}
{
metrics:
{
Description: Last uploaded date for metrics from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
logs:
{
Description: Last uploaded date for logs from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
usages:
{
Description: Last uploaded date for usages from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
basicLoginInformation:
{
Description: Deprecated. Azure Arc Data Services data controller no longer expose any endpoint. All traffic are exposed through Kubernetes native API. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
metricsDashboardCredential:
{
Description: Login credential for metrics dashboard on the Kubernetes cluster. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
logsDashboardCredential:
{
Description: Login credential for logs dashboard on the Kubernetes cluster. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
logAnalyticsWorkspaceConfig:
{
Description: Log analytics workspace id and primary key ,
Required: False ,
}
{
workspaceId:
{
Description: Azure Log Analytics workspace ID ,
Format: uuid ,
Required: False ,
}
string ,
primaryKey:
{
Description: Primary key of the workspace ,
Required: False ,
}
string ,
}
,
uploadServicePrincipal:
{
Description: Deprecated. Service principal is deprecated in favor of Arc Kubernetes service extension managed identity. ,
Required: False ,
}
{
clientId:
{
Description: Client ID of the service principal for uploading data. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the service principal. ,
Format: uuid ,
Required: False ,
}
string ,
authority:
{
Description: Authority for the service principal. Example: https://login.microsoftonline.com/ ,
Required: False ,
}
string ,
clientSecret:
{
Description: Secret of the service principal ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc Data Controller resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. ,
Required: False ,
}
string ,
extensionId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataControllers_PutDataController (new)
Description :  Creates or replaces a dataController resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers/{dataControllerName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
dataControllerResource:
{
Description: desc ,
Required: True ,
}
{
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The data controller's properties ,
Required: True ,
}
{
infrastructure:
{
Description: The infrastructure the data controller is running on. ,
Enum:
{
azure: No description available. ,
gcp: No description available. ,
aws: No description available. ,
alibaba: No description available. ,
onpremises: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
onPremiseProperty:
{
Description: Properties from the Kubernetes data controller ,
Required: False ,
}
{
id:
{
Description: A globally unique ID identifying the associated Kubernetes cluster ,
Format: uuid ,
Required: True ,
}
string ,
publicSigningKey:
{
Description: Certificate that contains the Kubernetes cluster public key used to verify signing ,
Required: True ,
}
string ,
signingCertificateThumbprint:
{
Description: Unique thumbprint returned to customer to verify the certificate being uploaded ,
Required: False ,
}
string ,
}
,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
object ,
uploadWatermark:
{
Description: Properties on upload watermark. Mostly timestamp for each upload data type ,
Required: False ,
}
{
metrics:
{
Description: Last uploaded date for metrics from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
logs:
{
Description: Last uploaded date for logs from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
usages:
{
Description: Last uploaded date for usages from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
basicLoginInformation:
{
Description: Deprecated. Azure Arc Data Services data controller no longer expose any endpoint. All traffic are exposed through Kubernetes native API. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
metricsDashboardCredential:
{
Description: Login credential for metrics dashboard on the Kubernetes cluster. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
logsDashboardCredential:
{
Description: Login credential for logs dashboard on the Kubernetes cluster. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
logAnalyticsWorkspaceConfig:
{
Description: Log analytics workspace id and primary key ,
Required: False ,
}
{
workspaceId:
{
Description: Azure Log Analytics workspace ID ,
Format: uuid ,
Required: False ,
}
string ,
primaryKey:
{
Description: Primary key of the workspace ,
Required: False ,
}
string ,
}
,
uploadServicePrincipal:
{
Description: Deprecated. Service principal is deprecated in favor of Arc Kubernetes service extension managed identity. ,
Required: False ,
}
{
clientId:
{
Description: Client ID of the service principal for uploading data. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the service principal. ,
Format: uuid ,
Required: False ,
}
string ,
authority:
{
Description: Authority for the service principal. Example: https://login.microsoftonline.com/ ,
Required: False ,
}
string ,
clientSecret:
{
Description: Secret of the service principal ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc Data Controller resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. ,
Required: False ,
}
string ,
extensionId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. ,
Required: False ,
}
string ,
}
,
}
,
dataControllerName:
{
Description: The name of the data controller ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The data controller's properties ,
Required: True ,
}
{
infrastructure:
{
Description: The infrastructure the data controller is running on. ,
Enum:
{
azure: No description available. ,
gcp: No description available. ,
aws: No description available. ,
alibaba: No description available. ,
onpremises: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
onPremiseProperty:
{
Description: Properties from the Kubernetes data controller ,
Required: False ,
}
{
id:
{
Description: A globally unique ID identifying the associated Kubernetes cluster ,
Format: uuid ,
Required: True ,
}
string ,
publicSigningKey:
{
Description: Certificate that contains the Kubernetes cluster public key used to verify signing ,
Required: True ,
}
string ,
signingCertificateThumbprint:
{
Description: Unique thumbprint returned to customer to verify the certificate being uploaded ,
Required: False ,
}
string ,
}
,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
object ,
uploadWatermark:
{
Description: Properties on upload watermark. Mostly timestamp for each upload data type ,
Required: False ,
}
{
metrics:
{
Description: Last uploaded date for metrics from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
logs:
{
Description: Last uploaded date for logs from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
usages:
{
Description: Last uploaded date for usages from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
basicLoginInformation:
{
Description: Deprecated. Azure Arc Data Services data controller no longer expose any endpoint. All traffic are exposed through Kubernetes native API. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
metricsDashboardCredential:
{
Description: Login credential for metrics dashboard on the Kubernetes cluster. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
logsDashboardCredential:
{
Description: Login credential for logs dashboard on the Kubernetes cluster. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
logAnalyticsWorkspaceConfig:
{
Description: Log analytics workspace id and primary key ,
Required: False ,
}
{
workspaceId:
{
Description: Azure Log Analytics workspace ID ,
Format: uuid ,
Required: False ,
}
string ,
primaryKey:
{
Description: Primary key of the workspace ,
Required: False ,
}
string ,
}
,
uploadServicePrincipal:
{
Description: Deprecated. Service principal is deprecated in favor of Arc Kubernetes service extension managed identity. ,
Required: False ,
}
{
clientId:
{
Description: Client ID of the service principal for uploading data. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the service principal. ,
Format: uuid ,
Required: False ,
}
string ,
authority:
{
Description: Authority for the service principal. Example: https://login.microsoftonline.com/ ,
Required: False ,
}
string ,
clientSecret:
{
Description: Secret of the service principal ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc Data Controller resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. ,
Required: False ,
}
string ,
extensionId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The data controller's properties ,
Required: True ,
}
{
infrastructure:
{
Description: The infrastructure the data controller is running on. ,
Enum:
{
azure: No description available. ,
gcp: No description available. ,
aws: No description available. ,
alibaba: No description available. ,
onpremises: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
onPremiseProperty:
{
Description: Properties from the Kubernetes data controller ,
Required: False ,
}
{
id:
{
Description: A globally unique ID identifying the associated Kubernetes cluster ,
Format: uuid ,
Required: True ,
}
string ,
publicSigningKey:
{
Description: Certificate that contains the Kubernetes cluster public key used to verify signing ,
Required: True ,
}
string ,
signingCertificateThumbprint:
{
Description: Unique thumbprint returned to customer to verify the certificate being uploaded ,
Required: False ,
}
string ,
}
,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
object ,
uploadWatermark:
{
Description: Properties on upload watermark. Mostly timestamp for each upload data type ,
Required: False ,
}
{
metrics:
{
Description: Last uploaded date for metrics from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
logs:
{
Description: Last uploaded date for logs from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
usages:
{
Description: Last uploaded date for usages from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
basicLoginInformation:
{
Description: Deprecated. Azure Arc Data Services data controller no longer expose any endpoint. All traffic are exposed through Kubernetes native API. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
metricsDashboardCredential:
{
Description: Login credential for metrics dashboard on the Kubernetes cluster. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
logsDashboardCredential:
{
Description: Login credential for logs dashboard on the Kubernetes cluster. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
logAnalyticsWorkspaceConfig:
{
Description: Log analytics workspace id and primary key ,
Required: False ,
}
{
workspaceId:
{
Description: Azure Log Analytics workspace ID ,
Format: uuid ,
Required: False ,
}
string ,
primaryKey:
{
Description: Primary key of the workspace ,
Required: False ,
}
string ,
}
,
uploadServicePrincipal:
{
Description: Deprecated. Service principal is deprecated in favor of Arc Kubernetes service extension managed identity. ,
Required: False ,
}
{
clientId:
{
Description: Client ID of the service principal for uploading data. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the service principal. ,
Format: uuid ,
Required: False ,
}
string ,
authority:
{
Description: Authority for the service principal. Example: https://login.microsoftonline.com/ ,
Required: False ,
}
string ,
clientSecret:
{
Description: Secret of the service principal ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc Data Controller resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. ,
Required: False ,
}
string ,
extensionId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataControllers_DeleteDataController (new)
Description :  Deletes a dataController resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers/{dataControllerName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
dataControllerName:
{
Description: The name of the data controller ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (204)

{}
DataControllers_GetDataController (new)
Description :  Retrieves a dataController resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers/{dataControllerName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
dataControllerName:
{
Description: The name of the data controller ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The data controller's properties ,
Required: True ,
}
{
infrastructure:
{
Description: The infrastructure the data controller is running on. ,
Enum:
{
azure: No description available. ,
gcp: No description available. ,
aws: No description available. ,
alibaba: No description available. ,
onpremises: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
onPremiseProperty:
{
Description: Properties from the Kubernetes data controller ,
Required: False ,
}
{
id:
{
Description: A globally unique ID identifying the associated Kubernetes cluster ,
Format: uuid ,
Required: True ,
}
string ,
publicSigningKey:
{
Description: Certificate that contains the Kubernetes cluster public key used to verify signing ,
Required: True ,
}
string ,
signingCertificateThumbprint:
{
Description: Unique thumbprint returned to customer to verify the certificate being uploaded ,
Required: False ,
}
string ,
}
,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
object ,
uploadWatermark:
{
Description: Properties on upload watermark. Mostly timestamp for each upload data type ,
Required: False ,
}
{
metrics:
{
Description: Last uploaded date for metrics from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
logs:
{
Description: Last uploaded date for logs from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
usages:
{
Description: Last uploaded date for usages from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
basicLoginInformation:
{
Description: Deprecated. Azure Arc Data Services data controller no longer expose any endpoint. All traffic are exposed through Kubernetes native API. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
metricsDashboardCredential:
{
Description: Login credential for metrics dashboard on the Kubernetes cluster. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
logsDashboardCredential:
{
Description: Login credential for logs dashboard on the Kubernetes cluster. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
logAnalyticsWorkspaceConfig:
{
Description: Log analytics workspace id and primary key ,
Required: False ,
}
{
workspaceId:
{
Description: Azure Log Analytics workspace ID ,
Format: uuid ,
Required: False ,
}
string ,
primaryKey:
{
Description: Primary key of the workspace ,
Required: False ,
}
string ,
}
,
uploadServicePrincipal:
{
Description: Deprecated. Service principal is deprecated in favor of Arc Kubernetes service extension managed identity. ,
Required: False ,
}
{
clientId:
{
Description: Client ID of the service principal for uploading data. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the service principal. ,
Format: uuid ,
Required: False ,
}
string ,
authority:
{
Description: Authority for the service principal. Example: https://login.microsoftonline.com/ ,
Required: False ,
}
string ,
clientSecret:
{
Description: Secret of the service principal ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc Data Controller resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. ,
Required: False ,
}
string ,
extensionId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataControllers_PatchDataController (new)
Description :  Updates a dataController resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers/{dataControllerName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
dataControllerName:
{
Description: The name of the data controller ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
dataControllerResource:
{
Description: The update data controller resource ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: The data controller's properties ,
Required: False ,
}
{
infrastructure:
{
Description: The infrastructure the data controller is running on. ,
Enum:
{
azure: No description available. ,
gcp: No description available. ,
aws: No description available. ,
alibaba: No description available. ,
onpremises: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
onPremiseProperty:
{
Description: Properties from the Kubernetes data controller ,
Required: False ,
}
{
id:
{
Description: A globally unique ID identifying the associated Kubernetes cluster ,
Format: uuid ,
Required: True ,
}
string ,
publicSigningKey:
{
Description: Certificate that contains the Kubernetes cluster public key used to verify signing ,
Required: True ,
}
string ,
signingCertificateThumbprint:
{
Description: Unique thumbprint returned to customer to verify the certificate being uploaded ,
Required: False ,
}
string ,
}
,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
object ,
uploadWatermark:
{
Description: Properties on upload watermark. Mostly timestamp for each upload data type ,
Required: False ,
}
{
metrics:
{
Description: Last uploaded date for metrics from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
logs:
{
Description: Last uploaded date for logs from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
usages:
{
Description: Last uploaded date for usages from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
basicLoginInformation:
{
Description: Deprecated. Azure Arc Data Services data controller no longer expose any endpoint. All traffic are exposed through Kubernetes native API. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
metricsDashboardCredential:
{
Description: Login credential for metrics dashboard on the Kubernetes cluster. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
logsDashboardCredential:
{
Description: Login credential for logs dashboard on the Kubernetes cluster. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
logAnalyticsWorkspaceConfig:
{
Description: Log analytics workspace id and primary key ,
Required: False ,
}
{
workspaceId:
{
Description: Azure Log Analytics workspace ID ,
Format: uuid ,
Required: False ,
}
string ,
primaryKey:
{
Description: Primary key of the workspace ,
Required: False ,
}
string ,
}
,
uploadServicePrincipal:
{
Description: Deprecated. Service principal is deprecated in favor of Arc Kubernetes service extension managed identity. ,
Required: False ,
}
{
clientId:
{
Description: Client ID of the service principal for uploading data. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the service principal. ,
Format: uuid ,
Required: False ,
}
string ,
authority:
{
Description: Authority for the service principal. Example: https://login.microsoftonline.com/ ,
Required: False ,
}
string ,
clientSecret:
{
Description: Secret of the service principal ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc Data Controller resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. ,
Required: False ,
}
string ,
extensionId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The data controller's properties ,
Required: True ,
}
{
infrastructure:
{
Description: The infrastructure the data controller is running on. ,
Enum:
{
azure: No description available. ,
gcp: No description available. ,
aws: No description available. ,
alibaba: No description available. ,
onpremises: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
onPremiseProperty:
{
Description: Properties from the Kubernetes data controller ,
Required: False ,
}
{
id:
{
Description: A globally unique ID identifying the associated Kubernetes cluster ,
Format: uuid ,
Required: True ,
}
string ,
publicSigningKey:
{
Description: Certificate that contains the Kubernetes cluster public key used to verify signing ,
Required: True ,
}
string ,
signingCertificateThumbprint:
{
Description: Unique thumbprint returned to customer to verify the certificate being uploaded ,
Required: False ,
}
string ,
}
,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
object ,
uploadWatermark:
{
Description: Properties on upload watermark. Mostly timestamp for each upload data type ,
Required: False ,
}
{
metrics:
{
Description: Last uploaded date for metrics from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
logs:
{
Description: Last uploaded date for logs from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
usages:
{
Description: Last uploaded date for usages from kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
basicLoginInformation:
{
Description: Deprecated. Azure Arc Data Services data controller no longer expose any endpoint. All traffic are exposed through Kubernetes native API. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
metricsDashboardCredential:
{
Description: Login credential for metrics dashboard on the Kubernetes cluster. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
logsDashboardCredential:
{
Description: Login credential for logs dashboard on the Kubernetes cluster. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
logAnalyticsWorkspaceConfig:
{
Description: Log analytics workspace id and primary key ,
Required: False ,
}
{
workspaceId:
{
Description: Azure Log Analytics workspace ID ,
Format: uuid ,
Required: False ,
}
string ,
primaryKey:
{
Description: Primary key of the workspace ,
Required: False ,
}
string ,
}
,
uploadServicePrincipal:
{
Description: Deprecated. Service principal is deprecated in favor of Arc Kubernetes service extension managed identity. ,
Required: False ,
}
{
clientId:
{
Description: Client ID of the service principal for uploading data. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the service principal. ,
Format: uuid ,
Required: False ,
}
string ,
authority:
{
Description: Authority for the service principal. Example: https://login.microsoftonline.com/ ,
Required: False ,
}
string ,
clientSecret:
{
Description: Secret of the service principal ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc Data Controller resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. ,
Required: False ,
}
string ,
extensionId:
{
Description: If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ActiveDirectoryConnectors_List (new)
Description :  List the active directory connectors associated with the given data controller.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers/{dataControllerName}/activeDirectoryConnectors
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
dataControllerName:
{
Description: The name of the data controller ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: null ,
Required: True ,
}
{
domainServiceAccountLoginInformation:
{
Description: Username and password for domain service account authentication. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Active Directory connector resource. ,
Required: False ,
}
string ,
spec:
{
Description: null ,
Required: True ,
}
{
activeDirectory:
{
Description: null ,
Required: True ,
}
{
realm:
{
Description: Name (uppercase) of the Active Directory domain that this AD connector will be associated with. ,
Required: True ,
}
string ,
netbiosDomainName:
{
Description: NETBIOS name of the Active Directory domain. ,
Required: False ,
}
string ,
serviceAccountProvisioning:
{
Description: The service account provisioning mode for this Active Directory connector. ,
Enum:
{
automatic: No description available. ,
manual: No description available. ,
}
,
Required: False ,
}
enum ,
ouDistinguishedName:
{
Description: The distinguished name of the Active Directory Organizational Unit. ,
Required: False ,
}
string ,
domainControllers:
{
Description: null ,
Required: False ,
}
{
primaryDomainController:
{
Description: Information about the Primary Domain Controller (PDC) in the AD domain. ,
Required: False ,
}
{
hostname:
{
Description: Fully-qualified domain name of a domain controller in the AD domain. ,
Required: True ,
}
string ,
}
,
secondaryDomainControllers:
{
Description: null ,
Required: False ,
}
[
{
hostname:
{
Description: Fully-qualified domain name of a domain controller in the AD domain. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
dns:
{
Description: null ,
Required: True ,
}
{
domainName:
{
Description: DNS domain name for which DNS lookups should be forwarded to the Active Directory DNS servers. ,
Required: False ,
}
string ,
nameserverIPAddresses:
{
Description: List of Active Directory DNS server IP addresses. ,
Required: True ,
}
[
string ,
]
,
replicas:
{
Description: Replica count for DNS proxy service. Default value is 1. ,
Format: int64 ,
Required: False ,
}
integer ,
preferK8sDnsForPtrLookups:
{
Description: Flag indicating whether to prefer Kubernetes DNS server response over AD DNS server response for IP address lookups. ,
Required: False ,
}
boolean ,
}
,
}
,
status:
{
Description: null ,
Required: False ,
}
{
lastUpdateTime:
{
Description: The time that the custom resource was last updated. ,
Required: False ,
}
string ,
observedGeneration:
{
Description: The version of the replicaSet associated with the AD connector custom resource. ,
Format: int64 ,
Required: False ,
}
integer ,
state:
{
Description: The state of the AD connector custom resource. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ActiveDirectoryConnectors_Create (new)
Description :  Creates or replaces an Active Directory connector resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers/{dataControllerName}/activeDirectoryConnectors/{activeDirectoryConnectorName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
activeDirectoryConnectorResource:
{
Description: desc ,
Required: True ,
}
{
properties:
{
Description: null ,
Required: True ,
}
{
domainServiceAccountLoginInformation:
{
Description: Username and password for domain service account authentication. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Active Directory connector resource. ,
Required: False ,
}
string ,
spec:
{
Description: null ,
Required: True ,
}
{
activeDirectory:
{
Description: null ,
Required: True ,
}
{
realm:
{
Description: Name (uppercase) of the Active Directory domain that this AD connector will be associated with. ,
Required: True ,
}
string ,
netbiosDomainName:
{
Description: NETBIOS name of the Active Directory domain. ,
Required: False ,
}
string ,
serviceAccountProvisioning:
{
Description: The service account provisioning mode for this Active Directory connector. ,
Enum:
{
automatic: No description available. ,
manual: No description available. ,
}
,
Required: False ,
}
enum ,
ouDistinguishedName:
{
Description: The distinguished name of the Active Directory Organizational Unit. ,
Required: False ,
}
string ,
domainControllers:
{
Description: null ,
Required: False ,
}
{
primaryDomainController:
{
Description: Information about the Primary Domain Controller (PDC) in the AD domain. ,
Required: False ,
}
{
hostname:
{
Description: Fully-qualified domain name of a domain controller in the AD domain. ,
Required: True ,
}
string ,
}
,
secondaryDomainControllers:
{
Description: null ,
Required: False ,
}
[
{
hostname:
{
Description: Fully-qualified domain name of a domain controller in the AD domain. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
dns:
{
Description: null ,
Required: True ,
}
{
domainName:
{
Description: DNS domain name for which DNS lookups should be forwarded to the Active Directory DNS servers. ,
Required: False ,
}
string ,
nameserverIPAddresses:
{
Description: List of Active Directory DNS server IP addresses. ,
Required: True ,
}
[
string ,
]
,
replicas:
{
Description: Replica count for DNS proxy service. Default value is 1. ,
Format: int64 ,
Required: False ,
}
integer ,
preferK8sDnsForPtrLookups:
{
Description: Flag indicating whether to prefer Kubernetes DNS server response over AD DNS server response for IP address lookups. ,
Required: False ,
}
boolean ,
}
,
}
,
status:
{
Description: null ,
Required: False ,
}
{
lastUpdateTime:
{
Description: The time that the custom resource was last updated. ,
Required: False ,
}
string ,
observedGeneration:
{
Description: The version of the replicaSet associated with the AD connector custom resource. ,
Format: int64 ,
Required: False ,
}
integer ,
state:
{
Description: The state of the AD connector custom resource. ,
Required: False ,
}
string ,
}
,
}
,
}
,
dataControllerName:
{
Description: The name of the data controller ,
Required: True ,
}
string ,
activeDirectoryConnectorName:
{
Description: The name of the Active Directory connector instance ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: null ,
Required: True ,
}
{
domainServiceAccountLoginInformation:
{
Description: Username and password for domain service account authentication. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Active Directory connector resource. ,
Required: False ,
}
string ,
spec:
{
Description: null ,
Required: True ,
}
{
activeDirectory:
{
Description: null ,
Required: True ,
}
{
realm:
{
Description: Name (uppercase) of the Active Directory domain that this AD connector will be associated with. ,
Required: True ,
}
string ,
netbiosDomainName:
{
Description: NETBIOS name of the Active Directory domain. ,
Required: False ,
}
string ,
serviceAccountProvisioning:
{
Description: The service account provisioning mode for this Active Directory connector. ,
Enum:
{
automatic: No description available. ,
manual: No description available. ,
}
,
Required: False ,
}
enum ,
ouDistinguishedName:
{
Description: The distinguished name of the Active Directory Organizational Unit. ,
Required: False ,
}
string ,
domainControllers:
{
Description: null ,
Required: False ,
}
{
primaryDomainController:
{
Description: Information about the Primary Domain Controller (PDC) in the AD domain. ,
Required: False ,
}
{
hostname:
{
Description: Fully-qualified domain name of a domain controller in the AD domain. ,
Required: True ,
}
string ,
}
,
secondaryDomainControllers:
{
Description: null ,
Required: False ,
}
[
{
hostname:
{
Description: Fully-qualified domain name of a domain controller in the AD domain. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
dns:
{
Description: null ,
Required: True ,
}
{
domainName:
{
Description: DNS domain name for which DNS lookups should be forwarded to the Active Directory DNS servers. ,
Required: False ,
}
string ,
nameserverIPAddresses:
{
Description: List of Active Directory DNS server IP addresses. ,
Required: True ,
}
[
string ,
]
,
replicas:
{
Description: Replica count for DNS proxy service. Default value is 1. ,
Format: int64 ,
Required: False ,
}
integer ,
preferK8sDnsForPtrLookups:
{
Description: Flag indicating whether to prefer Kubernetes DNS server response over AD DNS server response for IP address lookups. ,
Required: False ,
}
boolean ,
}
,
}
,
status:
{
Description: null ,
Required: False ,
}
{
lastUpdateTime:
{
Description: The time that the custom resource was last updated. ,
Required: False ,
}
string ,
observedGeneration:
{
Description: The version of the replicaSet associated with the AD connector custom resource. ,
Format: int64 ,
Required: False ,
}
integer ,
state:
{
Description: The state of the AD connector custom resource. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: null ,
Required: True ,
}
{
domainServiceAccountLoginInformation:
{
Description: Username and password for domain service account authentication. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Active Directory connector resource. ,
Required: False ,
}
string ,
spec:
{
Description: null ,
Required: True ,
}
{
activeDirectory:
{
Description: null ,
Required: True ,
}
{
realm:
{
Description: Name (uppercase) of the Active Directory domain that this AD connector will be associated with. ,
Required: True ,
}
string ,
netbiosDomainName:
{
Description: NETBIOS name of the Active Directory domain. ,
Required: False ,
}
string ,
serviceAccountProvisioning:
{
Description: The service account provisioning mode for this Active Directory connector. ,
Enum:
{
automatic: No description available. ,
manual: No description available. ,
}
,
Required: False ,
}
enum ,
ouDistinguishedName:
{
Description: The distinguished name of the Active Directory Organizational Unit. ,
Required: False ,
}
string ,
domainControllers:
{
Description: null ,
Required: False ,
}
{
primaryDomainController:
{
Description: Information about the Primary Domain Controller (PDC) in the AD domain. ,
Required: False ,
}
{
hostname:
{
Description: Fully-qualified domain name of a domain controller in the AD domain. ,
Required: True ,
}
string ,
}
,
secondaryDomainControllers:
{
Description: null ,
Required: False ,
}
[
{
hostname:
{
Description: Fully-qualified domain name of a domain controller in the AD domain. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
dns:
{
Description: null ,
Required: True ,
}
{
domainName:
{
Description: DNS domain name for which DNS lookups should be forwarded to the Active Directory DNS servers. ,
Required: False ,
}
string ,
nameserverIPAddresses:
{
Description: List of Active Directory DNS server IP addresses. ,
Required: True ,
}
[
string ,
]
,
replicas:
{
Description: Replica count for DNS proxy service. Default value is 1. ,
Format: int64 ,
Required: False ,
}
integer ,
preferK8sDnsForPtrLookups:
{
Description: Flag indicating whether to prefer Kubernetes DNS server response over AD DNS server response for IP address lookups. ,
Required: False ,
}
boolean ,
}
,
}
,
status:
{
Description: null ,
Required: False ,
}
{
lastUpdateTime:
{
Description: The time that the custom resource was last updated. ,
Required: False ,
}
string ,
observedGeneration:
{
Description: The version of the replicaSet associated with the AD connector custom resource. ,
Format: int64 ,
Required: False ,
}
integer ,
state:
{
Description: The state of the AD connector custom resource. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ActiveDirectoryConnectors_Delete (new)
Description :  Deletes an Active Directory connector resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers/{dataControllerName}/activeDirectoryConnectors/{activeDirectoryConnectorName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
dataControllerName:
{
Description: The name of the data controller ,
Required: True ,
}
string ,
activeDirectoryConnectorName:
{
Description: The name of the Active Directory connector instance ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (204)

{}
ActiveDirectoryConnectors_Get (new)
Description :  Retrieves an Active Directory connector resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers/{dataControllerName}/activeDirectoryConnectors/{activeDirectoryConnectorName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
dataControllerName:
{
Description: The name of the data controller ,
Required: True ,
}
string ,
activeDirectoryConnectorName:
{
Description: The name of the Active Directory connector instance ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: null ,
Required: True ,
}
{
domainServiceAccountLoginInformation:
{
Description: Username and password for domain service account authentication. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Active Directory connector resource. ,
Required: False ,
}
string ,
spec:
{
Description: null ,
Required: True ,
}
{
activeDirectory:
{
Description: null ,
Required: True ,
}
{
realm:
{
Description: Name (uppercase) of the Active Directory domain that this AD connector will be associated with. ,
Required: True ,
}
string ,
netbiosDomainName:
{
Description: NETBIOS name of the Active Directory domain. ,
Required: False ,
}
string ,
serviceAccountProvisioning:
{
Description: The service account provisioning mode for this Active Directory connector. ,
Enum:
{
automatic: No description available. ,
manual: No description available. ,
}
,
Required: False ,
}
enum ,
ouDistinguishedName:
{
Description: The distinguished name of the Active Directory Organizational Unit. ,
Required: False ,
}
string ,
domainControllers:
{
Description: null ,
Required: False ,
}
{
primaryDomainController:
{
Description: Information about the Primary Domain Controller (PDC) in the AD domain. ,
Required: False ,
}
{
hostname:
{
Description: Fully-qualified domain name of a domain controller in the AD domain. ,
Required: True ,
}
string ,
}
,
secondaryDomainControllers:
{
Description: null ,
Required: False ,
}
[
{
hostname:
{
Description: Fully-qualified domain name of a domain controller in the AD domain. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
dns:
{
Description: null ,
Required: True ,
}
{
domainName:
{
Description: DNS domain name for which DNS lookups should be forwarded to the Active Directory DNS servers. ,
Required: False ,
}
string ,
nameserverIPAddresses:
{
Description: List of Active Directory DNS server IP addresses. ,
Required: True ,
}
[
string ,
]
,
replicas:
{
Description: Replica count for DNS proxy service. Default value is 1. ,
Format: int64 ,
Required: False ,
}
integer ,
preferK8sDnsForPtrLookups:
{
Description: Flag indicating whether to prefer Kubernetes DNS server response over AD DNS server response for IP address lookups. ,
Required: False ,
}
boolean ,
}
,
}
,
status:
{
Description: null ,
Required: False ,
}
{
lastUpdateTime:
{
Description: The time that the custom resource was last updated. ,
Required: False ,
}
string ,
observedGeneration:
{
Description: The version of the replicaSet associated with the AD connector custom resource. ,
Format: int64 ,
Required: False ,
}
integer ,
state:
{
Description: The state of the AD connector custom resource. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PostgresInstances_List (new)
Description :  List postgres Instance resources in the subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/postgresInstances
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: null ,
Required: True ,
}
{
dataControllerId:
{
Description: The data controller id ,
Required: False ,
}
string ,
admin:
{
Description: The instance admin ,
Required: False ,
}
string ,
basicLoginInformation:
{
Description: Username and password for basic authentication. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
object ,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Azure Arc-enabled PostgreSQL instance. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Resource sku. ,
Required: False ,
}
{
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier. ,
Enum:
{
Hyperscale: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PostgresInstances_ListByResourceGroup (new)
Description :  Get a postgres Instances list by Resource group name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/postgresInstances
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: null ,
Required: True ,
}
{
dataControllerId:
{
Description: The data controller id ,
Required: False ,
}
string ,
admin:
{
Description: The instance admin ,
Required: False ,
}
string ,
basicLoginInformation:
{
Description: Username and password for basic authentication. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
object ,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Azure Arc-enabled PostgreSQL instance. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Resource sku. ,
Required: False ,
}
{
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier. ,
Enum:
{
Hyperscale: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PostgresInstances_Get (new)
Description :  Retrieves a postgres Instance resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/postgresInstances/{postgresInstanceName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
postgresInstanceName:
{
Description: Name of Postgres Instance ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: null ,
Required: True ,
}
{
dataControllerId:
{
Description: The data controller id ,
Required: False ,
}
string ,
admin:
{
Description: The instance admin ,
Required: False ,
}
string ,
basicLoginInformation:
{
Description: Username and password for basic authentication. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
object ,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Azure Arc-enabled PostgreSQL instance. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Resource sku. ,
Required: False ,
}
{
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier. ,
Enum:
{
Hyperscale: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PostgresInstances_Create (new)
Description :  Creates or replaces a postgres Instance resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/postgresInstances/{postgresInstanceName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
postgresInstanceName:
{
Description: Name of Postgres Instance ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
resource:
{
Description: The postgres instance ,
Required: True ,
}
{
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: null ,
Required: True ,
}
{
dataControllerId:
{
Description: The data controller id ,
Required: False ,
}
string ,
admin:
{
Description: The instance admin ,
Required: False ,
}
string ,
basicLoginInformation:
{
Description: Username and password for basic authentication. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
object ,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Azure Arc-enabled PostgreSQL instance. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Resource sku. ,
Required: False ,
}
{
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier. ,
Enum:
{
Hyperscale: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: null ,
Required: True ,
}
{
dataControllerId:
{
Description: The data controller id ,
Required: False ,
}
string ,
admin:
{
Description: The instance admin ,
Required: False ,
}
string ,
basicLoginInformation:
{
Description: Username and password for basic authentication. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
object ,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Azure Arc-enabled PostgreSQL instance. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Resource sku. ,
Required: False ,
}
{
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier. ,
Enum:
{
Hyperscale: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: null ,
Required: True ,
}
{
dataControllerId:
{
Description: The data controller id ,
Required: False ,
}
string ,
admin:
{
Description: The instance admin ,
Required: False ,
}
string ,
basicLoginInformation:
{
Description: Username and password for basic authentication. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
object ,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Azure Arc-enabled PostgreSQL instance. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Resource sku. ,
Required: False ,
}
{
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier. ,
Enum:
{
Hyperscale: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PostgresInstances_Delete (new)
Description :  Deletes a postgres Instance resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/postgresInstances/{postgresInstanceName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
postgresInstanceName:
{
Description: Name of Postgres Instance ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (204)

{}
PostgresInstances_Update (new)
Description :  Updates a postgres Instance resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/postgresInstances/{postgresInstanceName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
postgresInstanceName:
{
Description: Name of Postgres Instance ,
Required: True ,
}
string ,
parameters:
{
Description: The Postgres Instance. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Postgres Instance properties. ,
Required: False ,
}
{
dataControllerId:
{
Description: The data controller id ,
Required: False ,
}
string ,
admin:
{
Description: The instance admin ,
Required: False ,
}
string ,
basicLoginInformation:
{
Description: Username and password for basic authentication. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
object ,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Azure Arc-enabled PostgreSQL instance. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: null ,
Required: True ,
}
{
dataControllerId:
{
Description: The data controller id ,
Required: False ,
}
string ,
admin:
{
Description: The instance admin ,
Required: False ,
}
string ,
basicLoginInformation:
{
Description: Username and password for basic authentication. ,
Required: False ,
}
{
username:
{
Description: Login username. ,
Required: False ,
}
string ,
password:
{
Description: Login password. ,
Required: False ,
}
string ,
}
,
k8sRaw:
{
Description: The raw kubernetes information ,
Required: False ,
}
object ,
lastUploadedDate:
{
Description: Last uploaded date from Kubernetes cluster. Defaults to current date time ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Azure Arc-enabled PostgreSQL instance. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Resource sku. ,
Required: False ,
}
{
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier. ,
Enum:
{
Hyperscale: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerAvailabilityGroups_Create (new)
Description :  Creates or replaces an Arc Sql Server Availability Group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerAvailabilityGroupResource:
{
Description: The request body for availability group resource. ,
Required: True ,
}
{
properties:
{
Description: Properties of Arc Sql Server availability group ,
Required: True ,
}
{
availabilityGroupId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
serverName:
{
Description: the SQL server name. ,
Required: False ,
}
string ,
instanceName:
{
Description: the SQL Server Instance name. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
collectionTimestamp:
{
Description: Timestamp for when the data was collected from the client machine. ,
Format: date-time ,
Required: False ,
}
string ,
info:
{
Description: Availability Group Info ,
Required: False ,
}
{
failureConditionLevel:
{
Description: User-defined failure condition level under which an automatic failover must be triggered. ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckTimeout:
{
Description: Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding. ,
Format: int32 ,
Required: False ,
}
integer ,
automatedBackupPreferenceDescription:
{
Description: Preferred location for performing backups on the availability databases in this availability group. ,
Required: False ,
}
string ,
version:
{
Description: SQL Server availability group current version. ,
Format: int32 ,
Required: False ,
}
integer ,
basicFeatures:
{
Description: Specifies whether this is a basic availability group. ,
Required: False ,
}
boolean ,
dtcSupport:
{
Description: Specifies whether DTC support has been enabled for this availability group. ,
Required: False ,
}
boolean ,
dbFailover:
{
Description: Specifies whether the availability group supports failover for database health conditions. ,
Required: False ,
}
boolean ,
isDistributed:
{
Description: Specifies whether this is a distributed availability group. ,
Required: False ,
}
boolean ,
clusterTypeDescription:
{
Description: SQL Server availability group cluster type description ,
Required: False ,
}
string ,
requiredSynchronizedSecondariesToCommit:
{
Description: The number of secondary replicas that must be in a synchronized state for a commit to complete. ,
Format: int32 ,
Required: False ,
}
integer ,
isContained:
{
Description: SQL Server availability group contained system databases. ,
Required: False ,
}
boolean ,
primaryReplica:
{
Description: Name of the server instance that is hosting the current primary replica. ,
Required: False ,
}
string ,
primaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of the primary replica. ,
Required: False ,
}
string ,
secondaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of a secondary replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a roll-up of the synchronization health of all availability replicas in the availability group. ,
Required: False ,
}
string ,
replicationPartnerType:
{
Enum:
{
SQLServer: No description available. ,
AzureSQLVM: No description available. ,
AzureSQLManagedInstance: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
listener:
{
Description: The listener for the sql server availability group ,
Required: False ,
}
{
dnsName:
{
Description: the DNS name for the listener. ,
Required: False ,
}
string ,
ipV4AddressesAndMasks:
{
Description: IP V4 Addresses and masks for the listener. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPV4 address ,
Required: False ,
}
string ,
mask:
{
Description: IPV4 netmask ,
Required: False ,
}
string ,
}
,
]
,
ipV6Addresses:
{
Description: IP V6 Addresses for the listener ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: Network port for the listener. Default is 1433. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
replicas:
{
Description: A list of Availability Group Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Replicas. ,
Required: False ,
}
[
{
replicaId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
replicaName:
{
Description: The replica name. ,
Required: False ,
}
string ,
replicaResourceId:
{
Description: Resource id of this replica. This is required for a distributed availability group, in which case it describes the location of the availability group that hosts one replica in the DAG. In a non-distributed availability group this field is optional but can be used to store the Azure resource id for AG. ,
Format: arm-id ,
Required: False ,
}
string ,
configure:
{
Description: null ,
Required: False ,
}
{
endpointName:
{
Description: Name of the mirroring endpoint URL ,
Required: False ,
}
string ,
endpointUrl:
{
Description: Mirroring endpoint URL of availability group replica ,
Required: False ,
}
string ,
endpointAuthenticationMode:
{
Description: Permitted authentication modes for the mirroring endpoint. ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
certificateName:
{
Description: Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified. ,
Required: False ,
}
string ,
endpointConnectLogin:
{
Description: The login which will connect to the mirroring endpoint. ,
Required: False ,
}
string ,
availabilityMode:
{
Description: Property that determines whether a given availability replica can run in synchronous-commit mode ,
Enum:
{
SYNCHRONOUS_COMMIT: No description available. ,
ASYNCHRONOUS_COMMIT: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityModeDescription:
{
Description: The Availability Synchronization mode of the availability group replica. ,
Required: False ,
}
string ,
failoverMode:
{
Description: Property to set the failover mode of the availability group replica ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
EXTERNAL: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
failoverModeDescription:
{
Description: The failover mode of the availability group replica. ,
Required: False ,
}
string ,
sessionTimeout:
{
Description: The time-out period of availability group session replica, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
primaryAllowConnections:
{
Description: Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections) ,
Enum:
{
ALL: No description available. ,
READ_WRITE: No description available. ,
}
,
Required: False ,
}
enum ,
primaryRoleAllowConnectionsDescription:
{
Description: Whether the availability allows all connections or only read-write connections. ,
Required: False ,
}
string ,
secondaryAllowConnections:
{
Description: Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections. ,
Enum:
{
NO: No description available. ,
ALL: No description available. ,
READ_ONLY: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryRoleAllowConnectionsDescription:
{
Description: Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients. ,
Required: False ,
}
string ,
replicaCreateDate:
{
Description: Date that the replica was created. ,
Format: date-time ,
Required: False ,
}
string ,
replicaModifyDate:
{
Description: Date that the replica was modified. ,
Format: date-time ,
Required: False ,
}
string ,
backupPriority:
{
Description: Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. ,
Format: int32 ,
Required: False ,
}
integer ,
readOnlyRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read only availability replica. ,
Required: False ,
}
string ,
readWriteRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read write availability replica. ,
Required: False ,
}
string ,
seedingMode:
{
Description: Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica. ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
}
,
Required: False ,
}
enum ,
seedingModeDescription:
{
Description: Describes seeding mode. ,
Required: False ,
}
string ,
}
,
state:
{
Description: null ,
Required: False ,
}
{
availabilityGroupReplicaRole:
{
Description: Current Always On availability groups role of the availability group replica. ,
Required: False ,
}
string ,
operationalStateDescription:
{
Description: Current operational state of the availability group replica ,
Required: False ,
}
string ,
recoveryHealthDescription:
{
Description: Recovery health of the availability group replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica. ,
Required: False ,
}
string ,
connectedStateDescription:
{
Description: Whether a secondary replica is currently connected to the primary replica. ,
Required: False ,
}
string ,
lastConnectErrorDescription:
{
Description: Text description of the last connection error of the availability group replica. ,
Required: False ,
}
string ,
lastConnectErrorTimestamp:
{
Description: Date and time timestamp indicating when the last connect error occurred. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
databases:
{
Description: A list of Availability Group Database Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Database Replicas. ,
Required: False ,
}
[
{
databaseName:
{
Description: the database name. ,
Required: False ,
}
string ,
replicaName:
{
Description: the database replica name. ,
Required: False ,
}
string ,
isLocal:
{
Description: Whether the availability database is local. ,
Required: False ,
}
boolean ,
isPrimaryReplica:
{
Description: Returns 1 if the replica is primary, or 0 if it is a secondary replica. ,
Required: False ,
}
boolean ,
synchronizationStateDescription:
{
Description: Description of the data-movement state. ,
Required: False ,
}
string ,
isCommitParticipant:
{
Description: Whether this replica is transaction committer. ,
Required: False ,
}
boolean ,
synchronizationHealthDescription:
{
Description: Description of the health of database. ,
Required: False ,
}
string ,
databaseStateDescription:
{
Description: Description of the database state of the availability replica. ,
Required: False ,
}
string ,
isSuspended:
{
Description: Whether this data movement is suspended. ,
Required: False ,
}
boolean ,
suspendReasonDescription:
{
Description: Description of the database suspended state reason. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server availability group resource. ,
Required: False ,
}
string ,
}
,
}
,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
availabilityGroupName:
{
Description: Name of SQL Availability Group ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Arc Sql Server availability group ,
Required: True ,
}
{
availabilityGroupId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
serverName:
{
Description: the SQL server name. ,
Required: False ,
}
string ,
instanceName:
{
Description: the SQL Server Instance name. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
collectionTimestamp:
{
Description: Timestamp for when the data was collected from the client machine. ,
Format: date-time ,
Required: False ,
}
string ,
info:
{
Description: Availability Group Info ,
Required: False ,
}
{
failureConditionLevel:
{
Description: User-defined failure condition level under which an automatic failover must be triggered. ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckTimeout:
{
Description: Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding. ,
Format: int32 ,
Required: False ,
}
integer ,
automatedBackupPreferenceDescription:
{
Description: Preferred location for performing backups on the availability databases in this availability group. ,
Required: False ,
}
string ,
version:
{
Description: SQL Server availability group current version. ,
Format: int32 ,
Required: False ,
}
integer ,
basicFeatures:
{
Description: Specifies whether this is a basic availability group. ,
Required: False ,
}
boolean ,
dtcSupport:
{
Description: Specifies whether DTC support has been enabled for this availability group. ,
Required: False ,
}
boolean ,
dbFailover:
{
Description: Specifies whether the availability group supports failover for database health conditions. ,
Required: False ,
}
boolean ,
isDistributed:
{
Description: Specifies whether this is a distributed availability group. ,
Required: False ,
}
boolean ,
clusterTypeDescription:
{
Description: SQL Server availability group cluster type description ,
Required: False ,
}
string ,
requiredSynchronizedSecondariesToCommit:
{
Description: The number of secondary replicas that must be in a synchronized state for a commit to complete. ,
Format: int32 ,
Required: False ,
}
integer ,
isContained:
{
Description: SQL Server availability group contained system databases. ,
Required: False ,
}
boolean ,
primaryReplica:
{
Description: Name of the server instance that is hosting the current primary replica. ,
Required: False ,
}
string ,
primaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of the primary replica. ,
Required: False ,
}
string ,
secondaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of a secondary replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a roll-up of the synchronization health of all availability replicas in the availability group. ,
Required: False ,
}
string ,
replicationPartnerType:
{
Enum:
{
SQLServer: No description available. ,
AzureSQLVM: No description available. ,
AzureSQLManagedInstance: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
listener:
{
Description: The listener for the sql server availability group ,
Required: False ,
}
{
dnsName:
{
Description: the DNS name for the listener. ,
Required: False ,
}
string ,
ipV4AddressesAndMasks:
{
Description: IP V4 Addresses and masks for the listener. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPV4 address ,
Required: False ,
}
string ,
mask:
{
Description: IPV4 netmask ,
Required: False ,
}
string ,
}
,
]
,
ipV6Addresses:
{
Description: IP V6 Addresses for the listener ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: Network port for the listener. Default is 1433. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
replicas:
{
Description: A list of Availability Group Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Replicas. ,
Required: False ,
}
[
{
replicaId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
replicaName:
{
Description: The replica name. ,
Required: False ,
}
string ,
replicaResourceId:
{
Description: Resource id of this replica. This is required for a distributed availability group, in which case it describes the location of the availability group that hosts one replica in the DAG. In a non-distributed availability group this field is optional but can be used to store the Azure resource id for AG. ,
Format: arm-id ,
Required: False ,
}
string ,
configure:
{
Description: null ,
Required: False ,
}
{
endpointName:
{
Description: Name of the mirroring endpoint URL ,
Required: False ,
}
string ,
endpointUrl:
{
Description: Mirroring endpoint URL of availability group replica ,
Required: False ,
}
string ,
endpointAuthenticationMode:
{
Description: Permitted authentication modes for the mirroring endpoint. ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
certificateName:
{
Description: Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified. ,
Required: False ,
}
string ,
endpointConnectLogin:
{
Description: The login which will connect to the mirroring endpoint. ,
Required: False ,
}
string ,
availabilityMode:
{
Description: Property that determines whether a given availability replica can run in synchronous-commit mode ,
Enum:
{
SYNCHRONOUS_COMMIT: No description available. ,
ASYNCHRONOUS_COMMIT: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityModeDescription:
{
Description: The Availability Synchronization mode of the availability group replica. ,
Required: False ,
}
string ,
failoverMode:
{
Description: Property to set the failover mode of the availability group replica ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
EXTERNAL: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
failoverModeDescription:
{
Description: The failover mode of the availability group replica. ,
Required: False ,
}
string ,
sessionTimeout:
{
Description: The time-out period of availability group session replica, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
primaryAllowConnections:
{
Description: Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections) ,
Enum:
{
ALL: No description available. ,
READ_WRITE: No description available. ,
}
,
Required: False ,
}
enum ,
primaryRoleAllowConnectionsDescription:
{
Description: Whether the availability allows all connections or only read-write connections. ,
Required: False ,
}
string ,
secondaryAllowConnections:
{
Description: Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections. ,
Enum:
{
NO: No description available. ,
ALL: No description available. ,
READ_ONLY: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryRoleAllowConnectionsDescription:
{
Description: Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients. ,
Required: False ,
}
string ,
replicaCreateDate:
{
Description: Date that the replica was created. ,
Format: date-time ,
Required: False ,
}
string ,
replicaModifyDate:
{
Description: Date that the replica was modified. ,
Format: date-time ,
Required: False ,
}
string ,
backupPriority:
{
Description: Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. ,
Format: int32 ,
Required: False ,
}
integer ,
readOnlyRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read only availability replica. ,
Required: False ,
}
string ,
readWriteRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read write availability replica. ,
Required: False ,
}
string ,
seedingMode:
{
Description: Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica. ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
}
,
Required: False ,
}
enum ,
seedingModeDescription:
{
Description: Describes seeding mode. ,
Required: False ,
}
string ,
}
,
state:
{
Description: null ,
Required: False ,
}
{
availabilityGroupReplicaRole:
{
Description: Current Always On availability groups role of the availability group replica. ,
Required: False ,
}
string ,
operationalStateDescription:
{
Description: Current operational state of the availability group replica ,
Required: False ,
}
string ,
recoveryHealthDescription:
{
Description: Recovery health of the availability group replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica. ,
Required: False ,
}
string ,
connectedStateDescription:
{
Description: Whether a secondary replica is currently connected to the primary replica. ,
Required: False ,
}
string ,
lastConnectErrorDescription:
{
Description: Text description of the last connection error of the availability group replica. ,
Required: False ,
}
string ,
lastConnectErrorTimestamp:
{
Description: Date and time timestamp indicating when the last connect error occurred. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
databases:
{
Description: A list of Availability Group Database Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Database Replicas. ,
Required: False ,
}
[
{
databaseName:
{
Description: the database name. ,
Required: False ,
}
string ,
replicaName:
{
Description: the database replica name. ,
Required: False ,
}
string ,
isLocal:
{
Description: Whether the availability database is local. ,
Required: False ,
}
boolean ,
isPrimaryReplica:
{
Description: Returns 1 if the replica is primary, or 0 if it is a secondary replica. ,
Required: False ,
}
boolean ,
synchronizationStateDescription:
{
Description: Description of the data-movement state. ,
Required: False ,
}
string ,
isCommitParticipant:
{
Description: Whether this replica is transaction committer. ,
Required: False ,
}
boolean ,
synchronizationHealthDescription:
{
Description: Description of the health of database. ,
Required: False ,
}
string ,
databaseStateDescription:
{
Description: Description of the database state of the availability replica. ,
Required: False ,
}
string ,
isSuspended:
{
Description: Whether this data movement is suspended. ,
Required: False ,
}
boolean ,
suspendReasonDescription:
{
Description: Description of the database suspended state reason. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server availability group resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of Arc Sql Server availability group ,
Required: True ,
}
{
availabilityGroupId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
serverName:
{
Description: the SQL server name. ,
Required: False ,
}
string ,
instanceName:
{
Description: the SQL Server Instance name. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
collectionTimestamp:
{
Description: Timestamp for when the data was collected from the client machine. ,
Format: date-time ,
Required: False ,
}
string ,
info:
{
Description: Availability Group Info ,
Required: False ,
}
{
failureConditionLevel:
{
Description: User-defined failure condition level under which an automatic failover must be triggered. ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckTimeout:
{
Description: Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding. ,
Format: int32 ,
Required: False ,
}
integer ,
automatedBackupPreferenceDescription:
{
Description: Preferred location for performing backups on the availability databases in this availability group. ,
Required: False ,
}
string ,
version:
{
Description: SQL Server availability group current version. ,
Format: int32 ,
Required: False ,
}
integer ,
basicFeatures:
{
Description: Specifies whether this is a basic availability group. ,
Required: False ,
}
boolean ,
dtcSupport:
{
Description: Specifies whether DTC support has been enabled for this availability group. ,
Required: False ,
}
boolean ,
dbFailover:
{
Description: Specifies whether the availability group supports failover for database health conditions. ,
Required: False ,
}
boolean ,
isDistributed:
{
Description: Specifies whether this is a distributed availability group. ,
Required: False ,
}
boolean ,
clusterTypeDescription:
{
Description: SQL Server availability group cluster type description ,
Required: False ,
}
string ,
requiredSynchronizedSecondariesToCommit:
{
Description: The number of secondary replicas that must be in a synchronized state for a commit to complete. ,
Format: int32 ,
Required: False ,
}
integer ,
isContained:
{
Description: SQL Server availability group contained system databases. ,
Required: False ,
}
boolean ,
primaryReplica:
{
Description: Name of the server instance that is hosting the current primary replica. ,
Required: False ,
}
string ,
primaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of the primary replica. ,
Required: False ,
}
string ,
secondaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of a secondary replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a roll-up of the synchronization health of all availability replicas in the availability group. ,
Required: False ,
}
string ,
replicationPartnerType:
{
Enum:
{
SQLServer: No description available. ,
AzureSQLVM: No description available. ,
AzureSQLManagedInstance: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
listener:
{
Description: The listener for the sql server availability group ,
Required: False ,
}
{
dnsName:
{
Description: the DNS name for the listener. ,
Required: False ,
}
string ,
ipV4AddressesAndMasks:
{
Description: IP V4 Addresses and masks for the listener. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPV4 address ,
Required: False ,
}
string ,
mask:
{
Description: IPV4 netmask ,
Required: False ,
}
string ,
}
,
]
,
ipV6Addresses:
{
Description: IP V6 Addresses for the listener ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: Network port for the listener. Default is 1433. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
replicas:
{
Description: A list of Availability Group Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Replicas. ,
Required: False ,
}
[
{
replicaId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
replicaName:
{
Description: The replica name. ,
Required: False ,
}
string ,
replicaResourceId:
{
Description: Resource id of this replica. This is required for a distributed availability group, in which case it describes the location of the availability group that hosts one replica in the DAG. In a non-distributed availability group this field is optional but can be used to store the Azure resource id for AG. ,
Format: arm-id ,
Required: False ,
}
string ,
configure:
{
Description: null ,
Required: False ,
}
{
endpointName:
{
Description: Name of the mirroring endpoint URL ,
Required: False ,
}
string ,
endpointUrl:
{
Description: Mirroring endpoint URL of availability group replica ,
Required: False ,
}
string ,
endpointAuthenticationMode:
{
Description: Permitted authentication modes for the mirroring endpoint. ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
certificateName:
{
Description: Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified. ,
Required: False ,
}
string ,
endpointConnectLogin:
{
Description: The login which will connect to the mirroring endpoint. ,
Required: False ,
}
string ,
availabilityMode:
{
Description: Property that determines whether a given availability replica can run in synchronous-commit mode ,
Enum:
{
SYNCHRONOUS_COMMIT: No description available. ,
ASYNCHRONOUS_COMMIT: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityModeDescription:
{
Description: The Availability Synchronization mode of the availability group replica. ,
Required: False ,
}
string ,
failoverMode:
{
Description: Property to set the failover mode of the availability group replica ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
EXTERNAL: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
failoverModeDescription:
{
Description: The failover mode of the availability group replica. ,
Required: False ,
}
string ,
sessionTimeout:
{
Description: The time-out period of availability group session replica, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
primaryAllowConnections:
{
Description: Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections) ,
Enum:
{
ALL: No description available. ,
READ_WRITE: No description available. ,
}
,
Required: False ,
}
enum ,
primaryRoleAllowConnectionsDescription:
{
Description: Whether the availability allows all connections or only read-write connections. ,
Required: False ,
}
string ,
secondaryAllowConnections:
{
Description: Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections. ,
Enum:
{
NO: No description available. ,
ALL: No description available. ,
READ_ONLY: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryRoleAllowConnectionsDescription:
{
Description: Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients. ,
Required: False ,
}
string ,
replicaCreateDate:
{
Description: Date that the replica was created. ,
Format: date-time ,
Required: False ,
}
string ,
replicaModifyDate:
{
Description: Date that the replica was modified. ,
Format: date-time ,
Required: False ,
}
string ,
backupPriority:
{
Description: Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. ,
Format: int32 ,
Required: False ,
}
integer ,
readOnlyRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read only availability replica. ,
Required: False ,
}
string ,
readWriteRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read write availability replica. ,
Required: False ,
}
string ,
seedingMode:
{
Description: Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica. ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
}
,
Required: False ,
}
enum ,
seedingModeDescription:
{
Description: Describes seeding mode. ,
Required: False ,
}
string ,
}
,
state:
{
Description: null ,
Required: False ,
}
{
availabilityGroupReplicaRole:
{
Description: Current Always On availability groups role of the availability group replica. ,
Required: False ,
}
string ,
operationalStateDescription:
{
Description: Current operational state of the availability group replica ,
Required: False ,
}
string ,
recoveryHealthDescription:
{
Description: Recovery health of the availability group replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica. ,
Required: False ,
}
string ,
connectedStateDescription:
{
Description: Whether a secondary replica is currently connected to the primary replica. ,
Required: False ,
}
string ,
lastConnectErrorDescription:
{
Description: Text description of the last connection error of the availability group replica. ,
Required: False ,
}
string ,
lastConnectErrorTimestamp:
{
Description: Date and time timestamp indicating when the last connect error occurred. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
databases:
{
Description: A list of Availability Group Database Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Database Replicas. ,
Required: False ,
}
[
{
databaseName:
{
Description: the database name. ,
Required: False ,
}
string ,
replicaName:
{
Description: the database replica name. ,
Required: False ,
}
string ,
isLocal:
{
Description: Whether the availability database is local. ,
Required: False ,
}
boolean ,
isPrimaryReplica:
{
Description: Returns 1 if the replica is primary, or 0 if it is a secondary replica. ,
Required: False ,
}
boolean ,
synchronizationStateDescription:
{
Description: Description of the data-movement state. ,
Required: False ,
}
string ,
isCommitParticipant:
{
Description: Whether this replica is transaction committer. ,
Required: False ,
}
boolean ,
synchronizationHealthDescription:
{
Description: Description of the health of database. ,
Required: False ,
}
string ,
databaseStateDescription:
{
Description: Description of the database state of the availability replica. ,
Required: False ,
}
string ,
isSuspended:
{
Description: Whether this data movement is suspended. ,
Required: False ,
}
boolean ,
suspendReasonDescription:
{
Description: Description of the database suspended state reason. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server availability group resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerAvailabilityGroups_Delete (new)
Description :  Deletes an Arc Sql Server availability group resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
availabilityGroupName:
{
Description: Name of SQL Availability Group ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerAvailabilityGroups_Get (new)
Description :  Retrieves an Arc Sql Server availability group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
availabilityGroupName:
{
Description: Name of SQL Availability Group ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Arc Sql Server availability group ,
Required: True ,
}
{
availabilityGroupId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
serverName:
{
Description: the SQL server name. ,
Required: False ,
}
string ,
instanceName:
{
Description: the SQL Server Instance name. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
collectionTimestamp:
{
Description: Timestamp for when the data was collected from the client machine. ,
Format: date-time ,
Required: False ,
}
string ,
info:
{
Description: Availability Group Info ,
Required: False ,
}
{
failureConditionLevel:
{
Description: User-defined failure condition level under which an automatic failover must be triggered. ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckTimeout:
{
Description: Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding. ,
Format: int32 ,
Required: False ,
}
integer ,
automatedBackupPreferenceDescription:
{
Description: Preferred location for performing backups on the availability databases in this availability group. ,
Required: False ,
}
string ,
version:
{
Description: SQL Server availability group current version. ,
Format: int32 ,
Required: False ,
}
integer ,
basicFeatures:
{
Description: Specifies whether this is a basic availability group. ,
Required: False ,
}
boolean ,
dtcSupport:
{
Description: Specifies whether DTC support has been enabled for this availability group. ,
Required: False ,
}
boolean ,
dbFailover:
{
Description: Specifies whether the availability group supports failover for database health conditions. ,
Required: False ,
}
boolean ,
isDistributed:
{
Description: Specifies whether this is a distributed availability group. ,
Required: False ,
}
boolean ,
clusterTypeDescription:
{
Description: SQL Server availability group cluster type description ,
Required: False ,
}
string ,
requiredSynchronizedSecondariesToCommit:
{
Description: The number of secondary replicas that must be in a synchronized state for a commit to complete. ,
Format: int32 ,
Required: False ,
}
integer ,
isContained:
{
Description: SQL Server availability group contained system databases. ,
Required: False ,
}
boolean ,
primaryReplica:
{
Description: Name of the server instance that is hosting the current primary replica. ,
Required: False ,
}
string ,
primaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of the primary replica. ,
Required: False ,
}
string ,
secondaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of a secondary replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a roll-up of the synchronization health of all availability replicas in the availability group. ,
Required: False ,
}
string ,
replicationPartnerType:
{
Enum:
{
SQLServer: No description available. ,
AzureSQLVM: No description available. ,
AzureSQLManagedInstance: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
listener:
{
Description: The listener for the sql server availability group ,
Required: False ,
}
{
dnsName:
{
Description: the DNS name for the listener. ,
Required: False ,
}
string ,
ipV4AddressesAndMasks:
{
Description: IP V4 Addresses and masks for the listener. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPV4 address ,
Required: False ,
}
string ,
mask:
{
Description: IPV4 netmask ,
Required: False ,
}
string ,
}
,
]
,
ipV6Addresses:
{
Description: IP V6 Addresses for the listener ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: Network port for the listener. Default is 1433. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
replicas:
{
Description: A list of Availability Group Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Replicas. ,
Required: False ,
}
[
{
replicaId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
replicaName:
{
Description: The replica name. ,
Required: False ,
}
string ,
replicaResourceId:
{
Description: Resource id of this replica. This is required for a distributed availability group, in which case it describes the location of the availability group that hosts one replica in the DAG. In a non-distributed availability group this field is optional but can be used to store the Azure resource id for AG. ,
Format: arm-id ,
Required: False ,
}
string ,
configure:
{
Description: null ,
Required: False ,
}
{
endpointName:
{
Description: Name of the mirroring endpoint URL ,
Required: False ,
}
string ,
endpointUrl:
{
Description: Mirroring endpoint URL of availability group replica ,
Required: False ,
}
string ,
endpointAuthenticationMode:
{
Description: Permitted authentication modes for the mirroring endpoint. ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
certificateName:
{
Description: Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified. ,
Required: False ,
}
string ,
endpointConnectLogin:
{
Description: The login which will connect to the mirroring endpoint. ,
Required: False ,
}
string ,
availabilityMode:
{
Description: Property that determines whether a given availability replica can run in synchronous-commit mode ,
Enum:
{
SYNCHRONOUS_COMMIT: No description available. ,
ASYNCHRONOUS_COMMIT: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityModeDescription:
{
Description: The Availability Synchronization mode of the availability group replica. ,
Required: False ,
}
string ,
failoverMode:
{
Description: Property to set the failover mode of the availability group replica ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
EXTERNAL: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
failoverModeDescription:
{
Description: The failover mode of the availability group replica. ,
Required: False ,
}
string ,
sessionTimeout:
{
Description: The time-out period of availability group session replica, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
primaryAllowConnections:
{
Description: Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections) ,
Enum:
{
ALL: No description available. ,
READ_WRITE: No description available. ,
}
,
Required: False ,
}
enum ,
primaryRoleAllowConnectionsDescription:
{
Description: Whether the availability allows all connections or only read-write connections. ,
Required: False ,
}
string ,
secondaryAllowConnections:
{
Description: Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections. ,
Enum:
{
NO: No description available. ,
ALL: No description available. ,
READ_ONLY: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryRoleAllowConnectionsDescription:
{
Description: Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients. ,
Required: False ,
}
string ,
replicaCreateDate:
{
Description: Date that the replica was created. ,
Format: date-time ,
Required: False ,
}
string ,
replicaModifyDate:
{
Description: Date that the replica was modified. ,
Format: date-time ,
Required: False ,
}
string ,
backupPriority:
{
Description: Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. ,
Format: int32 ,
Required: False ,
}
integer ,
readOnlyRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read only availability replica. ,
Required: False ,
}
string ,
readWriteRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read write availability replica. ,
Required: False ,
}
string ,
seedingMode:
{
Description: Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica. ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
}
,
Required: False ,
}
enum ,
seedingModeDescription:
{
Description: Describes seeding mode. ,
Required: False ,
}
string ,
}
,
state:
{
Description: null ,
Required: False ,
}
{
availabilityGroupReplicaRole:
{
Description: Current Always On availability groups role of the availability group replica. ,
Required: False ,
}
string ,
operationalStateDescription:
{
Description: Current operational state of the availability group replica ,
Required: False ,
}
string ,
recoveryHealthDescription:
{
Description: Recovery health of the availability group replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica. ,
Required: False ,
}
string ,
connectedStateDescription:
{
Description: Whether a secondary replica is currently connected to the primary replica. ,
Required: False ,
}
string ,
lastConnectErrorDescription:
{
Description: Text description of the last connection error of the availability group replica. ,
Required: False ,
}
string ,
lastConnectErrorTimestamp:
{
Description: Date and time timestamp indicating when the last connect error occurred. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
databases:
{
Description: A list of Availability Group Database Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Database Replicas. ,
Required: False ,
}
[
{
databaseName:
{
Description: the database name. ,
Required: False ,
}
string ,
replicaName:
{
Description: the database replica name. ,
Required: False ,
}
string ,
isLocal:
{
Description: Whether the availability database is local. ,
Required: False ,
}
boolean ,
isPrimaryReplica:
{
Description: Returns 1 if the replica is primary, or 0 if it is a secondary replica. ,
Required: False ,
}
boolean ,
synchronizationStateDescription:
{
Description: Description of the data-movement state. ,
Required: False ,
}
string ,
isCommitParticipant:
{
Description: Whether this replica is transaction committer. ,
Required: False ,
}
boolean ,
synchronizationHealthDescription:
{
Description: Description of the health of database. ,
Required: False ,
}
string ,
databaseStateDescription:
{
Description: Description of the database state of the availability replica. ,
Required: False ,
}
string ,
isSuspended:
{
Description: Whether this data movement is suspended. ,
Required: False ,
}
boolean ,
suspendReasonDescription:
{
Description: Description of the database suspended state reason. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server availability group resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerAvailabilityGroups_Update (new)
Description :  Updates an existing Availability Group.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
availabilityGroupName:
{
Description: Name of SQL Availability Group ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
sqlServerAvailabilityGroupUpdate:
{
Description: The requested server availability group resource state. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The Server Availability Group's properties ,
Required: False ,
}
{
availabilityGroupId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
serverName:
{
Description: the SQL server name. ,
Required: False ,
}
string ,
instanceName:
{
Description: the SQL Server Instance name. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
collectionTimestamp:
{
Description: Timestamp for when the data was collected from the client machine. ,
Format: date-time ,
Required: False ,
}
string ,
info:
{
Description: Availability Group Info ,
Required: False ,
}
{
failureConditionLevel:
{
Description: User-defined failure condition level under which an automatic failover must be triggered. ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckTimeout:
{
Description: Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding. ,
Format: int32 ,
Required: False ,
}
integer ,
automatedBackupPreferenceDescription:
{
Description: Preferred location for performing backups on the availability databases in this availability group. ,
Required: False ,
}
string ,
version:
{
Description: SQL Server availability group current version. ,
Format: int32 ,
Required: False ,
}
integer ,
basicFeatures:
{
Description: Specifies whether this is a basic availability group. ,
Required: False ,
}
boolean ,
dtcSupport:
{
Description: Specifies whether DTC support has been enabled for this availability group. ,
Required: False ,
}
boolean ,
dbFailover:
{
Description: Specifies whether the availability group supports failover for database health conditions. ,
Required: False ,
}
boolean ,
isDistributed:
{
Description: Specifies whether this is a distributed availability group. ,
Required: False ,
}
boolean ,
clusterTypeDescription:
{
Description: SQL Server availability group cluster type description ,
Required: False ,
}
string ,
requiredSynchronizedSecondariesToCommit:
{
Description: The number of secondary replicas that must be in a synchronized state for a commit to complete. ,
Format: int32 ,
Required: False ,
}
integer ,
isContained:
{
Description: SQL Server availability group contained system databases. ,
Required: False ,
}
boolean ,
primaryReplica:
{
Description: Name of the server instance that is hosting the current primary replica. ,
Required: False ,
}
string ,
primaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of the primary replica. ,
Required: False ,
}
string ,
secondaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of a secondary replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a roll-up of the synchronization health of all availability replicas in the availability group. ,
Required: False ,
}
string ,
replicationPartnerType:
{
Enum:
{
SQLServer: No description available. ,
AzureSQLVM: No description available. ,
AzureSQLManagedInstance: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
listener:
{
Description: The listener for the sql server availability group ,
Required: False ,
}
{
dnsName:
{
Description: the DNS name for the listener. ,
Required: False ,
}
string ,
ipV4AddressesAndMasks:
{
Description: IP V4 Addresses and masks for the listener. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPV4 address ,
Required: False ,
}
string ,
mask:
{
Description: IPV4 netmask ,
Required: False ,
}
string ,
}
,
]
,
ipV6Addresses:
{
Description: IP V6 Addresses for the listener ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: Network port for the listener. Default is 1433. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
replicas:
{
Description: A list of Availability Group Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Replicas. ,
Required: False ,
}
[
{
replicaId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
replicaName:
{
Description: The replica name. ,
Required: False ,
}
string ,
replicaResourceId:
{
Description: Resource id of this replica. This is required for a distributed availability group, in which case it describes the location of the availability group that hosts one replica in the DAG. In a non-distributed availability group this field is optional but can be used to store the Azure resource id for AG. ,
Format: arm-id ,
Required: False ,
}
string ,
configure:
{
Description: null ,
Required: False ,
}
{
endpointName:
{
Description: Name of the mirroring endpoint URL ,
Required: False ,
}
string ,
endpointUrl:
{
Description: Mirroring endpoint URL of availability group replica ,
Required: False ,
}
string ,
endpointAuthenticationMode:
{
Description: Permitted authentication modes for the mirroring endpoint. ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
certificateName:
{
Description: Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified. ,
Required: False ,
}
string ,
endpointConnectLogin:
{
Description: The login which will connect to the mirroring endpoint. ,
Required: False ,
}
string ,
availabilityMode:
{
Description: Property that determines whether a given availability replica can run in synchronous-commit mode ,
Enum:
{
SYNCHRONOUS_COMMIT: No description available. ,
ASYNCHRONOUS_COMMIT: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityModeDescription:
{
Description: The Availability Synchronization mode of the availability group replica. ,
Required: False ,
}
string ,
failoverMode:
{
Description: Property to set the failover mode of the availability group replica ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
EXTERNAL: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
failoverModeDescription:
{
Description: The failover mode of the availability group replica. ,
Required: False ,
}
string ,
sessionTimeout:
{
Description: The time-out period of availability group session replica, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
primaryAllowConnections:
{
Description: Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections) ,
Enum:
{
ALL: No description available. ,
READ_WRITE: No description available. ,
}
,
Required: False ,
}
enum ,
primaryRoleAllowConnectionsDescription:
{
Description: Whether the availability allows all connections or only read-write connections. ,
Required: False ,
}
string ,
secondaryAllowConnections:
{
Description: Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections. ,
Enum:
{
NO: No description available. ,
ALL: No description available. ,
READ_ONLY: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryRoleAllowConnectionsDescription:
{
Description: Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients. ,
Required: False ,
}
string ,
replicaCreateDate:
{
Description: Date that the replica was created. ,
Format: date-time ,
Required: False ,
}
string ,
replicaModifyDate:
{
Description: Date that the replica was modified. ,
Format: date-time ,
Required: False ,
}
string ,
backupPriority:
{
Description: Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. ,
Format: int32 ,
Required: False ,
}
integer ,
readOnlyRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read only availability replica. ,
Required: False ,
}
string ,
readWriteRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read write availability replica. ,
Required: False ,
}
string ,
seedingMode:
{
Description: Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica. ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
}
,
Required: False ,
}
enum ,
seedingModeDescription:
{
Description: Describes seeding mode. ,
Required: False ,
}
string ,
}
,
state:
{
Description: null ,
Required: False ,
}
{
availabilityGroupReplicaRole:
{
Description: Current Always On availability groups role of the availability group replica. ,
Required: False ,
}
string ,
operationalStateDescription:
{
Description: Current operational state of the availability group replica ,
Required: False ,
}
string ,
recoveryHealthDescription:
{
Description: Recovery health of the availability group replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica. ,
Required: False ,
}
string ,
connectedStateDescription:
{
Description: Whether a secondary replica is currently connected to the primary replica. ,
Required: False ,
}
string ,
lastConnectErrorDescription:
{
Description: Text description of the last connection error of the availability group replica. ,
Required: False ,
}
string ,
lastConnectErrorTimestamp:
{
Description: Date and time timestamp indicating when the last connect error occurred. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
databases:
{
Description: A list of Availability Group Database Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Database Replicas. ,
Required: False ,
}
[
{
databaseName:
{
Description: the database name. ,
Required: False ,
}
string ,
replicaName:
{
Description: the database replica name. ,
Required: False ,
}
string ,
isLocal:
{
Description: Whether the availability database is local. ,
Required: False ,
}
boolean ,
isPrimaryReplica:
{
Description: Returns 1 if the replica is primary, or 0 if it is a secondary replica. ,
Required: False ,
}
boolean ,
synchronizationStateDescription:
{
Description: Description of the data-movement state. ,
Required: False ,
}
string ,
isCommitParticipant:
{
Description: Whether this replica is transaction committer. ,
Required: False ,
}
boolean ,
synchronizationHealthDescription:
{
Description: Description of the health of database. ,
Required: False ,
}
string ,
databaseStateDescription:
{
Description: Description of the database state of the availability replica. ,
Required: False ,
}
string ,
isSuspended:
{
Description: Whether this data movement is suspended. ,
Required: False ,
}
boolean ,
suspendReasonDescription:
{
Description: Description of the database suspended state reason. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server availability group resource. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Arc Sql Server availability group ,
Required: True ,
}
{
availabilityGroupId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
serverName:
{
Description: the SQL server name. ,
Required: False ,
}
string ,
instanceName:
{
Description: the SQL Server Instance name. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
collectionTimestamp:
{
Description: Timestamp for when the data was collected from the client machine. ,
Format: date-time ,
Required: False ,
}
string ,
info:
{
Description: Availability Group Info ,
Required: False ,
}
{
failureConditionLevel:
{
Description: User-defined failure condition level under which an automatic failover must be triggered. ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckTimeout:
{
Description: Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding. ,
Format: int32 ,
Required: False ,
}
integer ,
automatedBackupPreferenceDescription:
{
Description: Preferred location for performing backups on the availability databases in this availability group. ,
Required: False ,
}
string ,
version:
{
Description: SQL Server availability group current version. ,
Format: int32 ,
Required: False ,
}
integer ,
basicFeatures:
{
Description: Specifies whether this is a basic availability group. ,
Required: False ,
}
boolean ,
dtcSupport:
{
Description: Specifies whether DTC support has been enabled for this availability group. ,
Required: False ,
}
boolean ,
dbFailover:
{
Description: Specifies whether the availability group supports failover for database health conditions. ,
Required: False ,
}
boolean ,
isDistributed:
{
Description: Specifies whether this is a distributed availability group. ,
Required: False ,
}
boolean ,
clusterTypeDescription:
{
Description: SQL Server availability group cluster type description ,
Required: False ,
}
string ,
requiredSynchronizedSecondariesToCommit:
{
Description: The number of secondary replicas that must be in a synchronized state for a commit to complete. ,
Format: int32 ,
Required: False ,
}
integer ,
isContained:
{
Description: SQL Server availability group contained system databases. ,
Required: False ,
}
boolean ,
primaryReplica:
{
Description: Name of the server instance that is hosting the current primary replica. ,
Required: False ,
}
string ,
primaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of the primary replica. ,
Required: False ,
}
string ,
secondaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of a secondary replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a roll-up of the synchronization health of all availability replicas in the availability group. ,
Required: False ,
}
string ,
replicationPartnerType:
{
Enum:
{
SQLServer: No description available. ,
AzureSQLVM: No description available. ,
AzureSQLManagedInstance: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
listener:
{
Description: The listener for the sql server availability group ,
Required: False ,
}
{
dnsName:
{
Description: the DNS name for the listener. ,
Required: False ,
}
string ,
ipV4AddressesAndMasks:
{
Description: IP V4 Addresses and masks for the listener. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPV4 address ,
Required: False ,
}
string ,
mask:
{
Description: IPV4 netmask ,
Required: False ,
}
string ,
}
,
]
,
ipV6Addresses:
{
Description: IP V6 Addresses for the listener ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: Network port for the listener. Default is 1433. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
replicas:
{
Description: A list of Availability Group Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Replicas. ,
Required: False ,
}
[
{
replicaId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
replicaName:
{
Description: The replica name. ,
Required: False ,
}
string ,
replicaResourceId:
{
Description: Resource id of this replica. This is required for a distributed availability group, in which case it describes the location of the availability group that hosts one replica in the DAG. In a non-distributed availability group this field is optional but can be used to store the Azure resource id for AG. ,
Format: arm-id ,
Required: False ,
}
string ,
configure:
{
Description: null ,
Required: False ,
}
{
endpointName:
{
Description: Name of the mirroring endpoint URL ,
Required: False ,
}
string ,
endpointUrl:
{
Description: Mirroring endpoint URL of availability group replica ,
Required: False ,
}
string ,
endpointAuthenticationMode:
{
Description: Permitted authentication modes for the mirroring endpoint. ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
certificateName:
{
Description: Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified. ,
Required: False ,
}
string ,
endpointConnectLogin:
{
Description: The login which will connect to the mirroring endpoint. ,
Required: False ,
}
string ,
availabilityMode:
{
Description: Property that determines whether a given availability replica can run in synchronous-commit mode ,
Enum:
{
SYNCHRONOUS_COMMIT: No description available. ,
ASYNCHRONOUS_COMMIT: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityModeDescription:
{
Description: The Availability Synchronization mode of the availability group replica. ,
Required: False ,
}
string ,
failoverMode:
{
Description: Property to set the failover mode of the availability group replica ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
EXTERNAL: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
failoverModeDescription:
{
Description: The failover mode of the availability group replica. ,
Required: False ,
}
string ,
sessionTimeout:
{
Description: The time-out period of availability group session replica, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
primaryAllowConnections:
{
Description: Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections) ,
Enum:
{
ALL: No description available. ,
READ_WRITE: No description available. ,
}
,
Required: False ,
}
enum ,
primaryRoleAllowConnectionsDescription:
{
Description: Whether the availability allows all connections or only read-write connections. ,
Required: False ,
}
string ,
secondaryAllowConnections:
{
Description: Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections. ,
Enum:
{
NO: No description available. ,
ALL: No description available. ,
READ_ONLY: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryRoleAllowConnectionsDescription:
{
Description: Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients. ,
Required: False ,
}
string ,
replicaCreateDate:
{
Description: Date that the replica was created. ,
Format: date-time ,
Required: False ,
}
string ,
replicaModifyDate:
{
Description: Date that the replica was modified. ,
Format: date-time ,
Required: False ,
}
string ,
backupPriority:
{
Description: Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. ,
Format: int32 ,
Required: False ,
}
integer ,
readOnlyRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read only availability replica. ,
Required: False ,
}
string ,
readWriteRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read write availability replica. ,
Required: False ,
}
string ,
seedingMode:
{
Description: Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica. ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
}
,
Required: False ,
}
enum ,
seedingModeDescription:
{
Description: Describes seeding mode. ,
Required: False ,
}
string ,
}
,
state:
{
Description: null ,
Required: False ,
}
{
availabilityGroupReplicaRole:
{
Description: Current Always On availability groups role of the availability group replica. ,
Required: False ,
}
string ,
operationalStateDescription:
{
Description: Current operational state of the availability group replica ,
Required: False ,
}
string ,
recoveryHealthDescription:
{
Description: Recovery health of the availability group replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica. ,
Required: False ,
}
string ,
connectedStateDescription:
{
Description: Whether a secondary replica is currently connected to the primary replica. ,
Required: False ,
}
string ,
lastConnectErrorDescription:
{
Description: Text description of the last connection error of the availability group replica. ,
Required: False ,
}
string ,
lastConnectErrorTimestamp:
{
Description: Date and time timestamp indicating when the last connect error occurred. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
databases:
{
Description: A list of Availability Group Database Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Database Replicas. ,
Required: False ,
}
[
{
databaseName:
{
Description: the database name. ,
Required: False ,
}
string ,
replicaName:
{
Description: the database replica name. ,
Required: False ,
}
string ,
isLocal:
{
Description: Whether the availability database is local. ,
Required: False ,
}
boolean ,
isPrimaryReplica:
{
Description: Returns 1 if the replica is primary, or 0 if it is a secondary replica. ,
Required: False ,
}
boolean ,
synchronizationStateDescription:
{
Description: Description of the data-movement state. ,
Required: False ,
}
string ,
isCommitParticipant:
{
Description: Whether this replica is transaction committer. ,
Required: False ,
}
boolean ,
synchronizationHealthDescription:
{
Description: Description of the health of database. ,
Required: False ,
}
string ,
databaseStateDescription:
{
Description: Description of the database state of the availability replica. ,
Required: False ,
}
string ,
isSuspended:
{
Description: Whether this data movement is suspended. ,
Required: False ,
}
boolean ,
suspendReasonDescription:
{
Description: Description of the database suspended state reason. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server availability group resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerAvailabilityGroups_DetailView (new)
Description :  Retrieves detailed properties of the Availability Group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}/getDetailView
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
availabilityGroupName:
{
Description: Name of SQL Availability Group ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Arc Sql Server availability group ,
Required: True ,
}
{
availabilityGroupId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
serverName:
{
Description: the SQL server name. ,
Required: False ,
}
string ,
instanceName:
{
Description: the SQL Server Instance name. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
collectionTimestamp:
{
Description: Timestamp for when the data was collected from the client machine. ,
Format: date-time ,
Required: False ,
}
string ,
info:
{
Description: Availability Group Info ,
Required: False ,
}
{
failureConditionLevel:
{
Description: User-defined failure condition level under which an automatic failover must be triggered. ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckTimeout:
{
Description: Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding. ,
Format: int32 ,
Required: False ,
}
integer ,
automatedBackupPreferenceDescription:
{
Description: Preferred location for performing backups on the availability databases in this availability group. ,
Required: False ,
}
string ,
version:
{
Description: SQL Server availability group current version. ,
Format: int32 ,
Required: False ,
}
integer ,
basicFeatures:
{
Description: Specifies whether this is a basic availability group. ,
Required: False ,
}
boolean ,
dtcSupport:
{
Description: Specifies whether DTC support has been enabled for this availability group. ,
Required: False ,
}
boolean ,
dbFailover:
{
Description: Specifies whether the availability group supports failover for database health conditions. ,
Required: False ,
}
boolean ,
isDistributed:
{
Description: Specifies whether this is a distributed availability group. ,
Required: False ,
}
boolean ,
clusterTypeDescription:
{
Description: SQL Server availability group cluster type description ,
Required: False ,
}
string ,
requiredSynchronizedSecondariesToCommit:
{
Description: The number of secondary replicas that must be in a synchronized state for a commit to complete. ,
Format: int32 ,
Required: False ,
}
integer ,
isContained:
{
Description: SQL Server availability group contained system databases. ,
Required: False ,
}
boolean ,
primaryReplica:
{
Description: Name of the server instance that is hosting the current primary replica. ,
Required: False ,
}
string ,
primaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of the primary replica. ,
Required: False ,
}
string ,
secondaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of a secondary replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a roll-up of the synchronization health of all availability replicas in the availability group. ,
Required: False ,
}
string ,
replicationPartnerType:
{
Enum:
{
SQLServer: No description available. ,
AzureSQLVM: No description available. ,
AzureSQLManagedInstance: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
listener:
{
Description: The listener for the sql server availability group ,
Required: False ,
}
{
dnsName:
{
Description: the DNS name for the listener. ,
Required: False ,
}
string ,
ipV4AddressesAndMasks:
{
Description: IP V4 Addresses and masks for the listener. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPV4 address ,
Required: False ,
}
string ,
mask:
{
Description: IPV4 netmask ,
Required: False ,
}
string ,
}
,
]
,
ipV6Addresses:
{
Description: IP V6 Addresses for the listener ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: Network port for the listener. Default is 1433. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
replicas:
{
Description: A list of Availability Group Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Replicas. ,
Required: False ,
}
[
{
replicaId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
replicaName:
{
Description: The replica name. ,
Required: False ,
}
string ,
replicaResourceId:
{
Description: Resource id of this replica. This is required for a distributed availability group, in which case it describes the location of the availability group that hosts one replica in the DAG. In a non-distributed availability group this field is optional but can be used to store the Azure resource id for AG. ,
Format: arm-id ,
Required: False ,
}
string ,
configure:
{
Description: null ,
Required: False ,
}
{
endpointName:
{
Description: Name of the mirroring endpoint URL ,
Required: False ,
}
string ,
endpointUrl:
{
Description: Mirroring endpoint URL of availability group replica ,
Required: False ,
}
string ,
endpointAuthenticationMode:
{
Description: Permitted authentication modes for the mirroring endpoint. ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
certificateName:
{
Description: Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified. ,
Required: False ,
}
string ,
endpointConnectLogin:
{
Description: The login which will connect to the mirroring endpoint. ,
Required: False ,
}
string ,
availabilityMode:
{
Description: Property that determines whether a given availability replica can run in synchronous-commit mode ,
Enum:
{
SYNCHRONOUS_COMMIT: No description available. ,
ASYNCHRONOUS_COMMIT: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityModeDescription:
{
Description: The Availability Synchronization mode of the availability group replica. ,
Required: False ,
}
string ,
failoverMode:
{
Description: Property to set the failover mode of the availability group replica ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
EXTERNAL: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
failoverModeDescription:
{
Description: The failover mode of the availability group replica. ,
Required: False ,
}
string ,
sessionTimeout:
{
Description: The time-out period of availability group session replica, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
primaryAllowConnections:
{
Description: Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections) ,
Enum:
{
ALL: No description available. ,
READ_WRITE: No description available. ,
}
,
Required: False ,
}
enum ,
primaryRoleAllowConnectionsDescription:
{
Description: Whether the availability allows all connections or only read-write connections. ,
Required: False ,
}
string ,
secondaryAllowConnections:
{
Description: Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections. ,
Enum:
{
NO: No description available. ,
ALL: No description available. ,
READ_ONLY: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryRoleAllowConnectionsDescription:
{
Description: Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients. ,
Required: False ,
}
string ,
replicaCreateDate:
{
Description: Date that the replica was created. ,
Format: date-time ,
Required: False ,
}
string ,
replicaModifyDate:
{
Description: Date that the replica was modified. ,
Format: date-time ,
Required: False ,
}
string ,
backupPriority:
{
Description: Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. ,
Format: int32 ,
Required: False ,
}
integer ,
readOnlyRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read only availability replica. ,
Required: False ,
}
string ,
readWriteRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read write availability replica. ,
Required: False ,
}
string ,
seedingMode:
{
Description: Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica. ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
}
,
Required: False ,
}
enum ,
seedingModeDescription:
{
Description: Describes seeding mode. ,
Required: False ,
}
string ,
}
,
state:
{
Description: null ,
Required: False ,
}
{
availabilityGroupReplicaRole:
{
Description: Current Always On availability groups role of the availability group replica. ,
Required: False ,
}
string ,
operationalStateDescription:
{
Description: Current operational state of the availability group replica ,
Required: False ,
}
string ,
recoveryHealthDescription:
{
Description: Recovery health of the availability group replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica. ,
Required: False ,
}
string ,
connectedStateDescription:
{
Description: Whether a secondary replica is currently connected to the primary replica. ,
Required: False ,
}
string ,
lastConnectErrorDescription:
{
Description: Text description of the last connection error of the availability group replica. ,
Required: False ,
}
string ,
lastConnectErrorTimestamp:
{
Description: Date and time timestamp indicating when the last connect error occurred. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
databases:
{
Description: A list of Availability Group Database Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Database Replicas. ,
Required: False ,
}
[
{
databaseName:
{
Description: the database name. ,
Required: False ,
}
string ,
replicaName:
{
Description: the database replica name. ,
Required: False ,
}
string ,
isLocal:
{
Description: Whether the availability database is local. ,
Required: False ,
}
boolean ,
isPrimaryReplica:
{
Description: Returns 1 if the replica is primary, or 0 if it is a secondary replica. ,
Required: False ,
}
boolean ,
synchronizationStateDescription:
{
Description: Description of the data-movement state. ,
Required: False ,
}
string ,
isCommitParticipant:
{
Description: Whether this replica is transaction committer. ,
Required: False ,
}
boolean ,
synchronizationHealthDescription:
{
Description: Description of the health of database. ,
Required: False ,
}
string ,
databaseStateDescription:
{
Description: Description of the database state of the availability replica. ,
Required: False ,
}
string ,
isSuspended:
{
Description: Whether this data movement is suspended. ,
Required: False ,
}
boolean ,
suspendReasonDescription:
{
Description: Description of the database suspended state reason. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server availability group resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerInstances_GetAllAvailabilityGroups (new)
Description :  Retrieves full properties of all the Availability Groups in a SQL Server instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/getAllAvailabilityGroups
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
availabilityGroupRetrievalFilters:
{
Required: False ,
}
{
availabilityGroupTypeFilter:
{
Description: Filter retrieval based on availability group type. ,
Enum:
{
CONTAINED: Contained Availability Group (CAG). ,
DISTRIBUTED: Distributed Availability Group (DAG) ,
DEFAULT: Default standard availability group that is not contained or distributed. ,
}
,
Required: False ,
}
enum ,
replicationPartnerTypeFilter:
{
Enum:
{
SQLServer: No description available. ,
AzureSQLVM: No description available. ,
AzureSQLManagedInstance: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
value:
{
Description: Array of Arc Sql Server Availability Groups. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of Arc Sql Server availability group ,
Required: True ,
}
{
availabilityGroupId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
serverName:
{
Description: the SQL server name. ,
Required: False ,
}
string ,
instanceName:
{
Description: the SQL Server Instance name. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
collectionTimestamp:
{
Description: Timestamp for when the data was collected from the client machine. ,
Format: date-time ,
Required: False ,
}
string ,
info:
{
Description: Availability Group Info ,
Required: False ,
}
{
failureConditionLevel:
{
Description: User-defined failure condition level under which an automatic failover must be triggered. ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckTimeout:
{
Description: Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding. ,
Format: int32 ,
Required: False ,
}
integer ,
automatedBackupPreferenceDescription:
{
Description: Preferred location for performing backups on the availability databases in this availability group. ,
Required: False ,
}
string ,
version:
{
Description: SQL Server availability group current version. ,
Format: int32 ,
Required: False ,
}
integer ,
basicFeatures:
{
Description: Specifies whether this is a basic availability group. ,
Required: False ,
}
boolean ,
dtcSupport:
{
Description: Specifies whether DTC support has been enabled for this availability group. ,
Required: False ,
}
boolean ,
dbFailover:
{
Description: Specifies whether the availability group supports failover for database health conditions. ,
Required: False ,
}
boolean ,
isDistributed:
{
Description: Specifies whether this is a distributed availability group. ,
Required: False ,
}
boolean ,
clusterTypeDescription:
{
Description: SQL Server availability group cluster type description ,
Required: False ,
}
string ,
requiredSynchronizedSecondariesToCommit:
{
Description: The number of secondary replicas that must be in a synchronized state for a commit to complete. ,
Format: int32 ,
Required: False ,
}
integer ,
isContained:
{
Description: SQL Server availability group contained system databases. ,
Required: False ,
}
boolean ,
primaryReplica:
{
Description: Name of the server instance that is hosting the current primary replica. ,
Required: False ,
}
string ,
primaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of the primary replica. ,
Required: False ,
}
string ,
secondaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of a secondary replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a roll-up of the synchronization health of all availability replicas in the availability group. ,
Required: False ,
}
string ,
replicationPartnerType:
{
Enum:
{
SQLServer: No description available. ,
AzureSQLVM: No description available. ,
AzureSQLManagedInstance: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
listener:
{
Description: The listener for the sql server availability group ,
Required: False ,
}
{
dnsName:
{
Description: the DNS name for the listener. ,
Required: False ,
}
string ,
ipV4AddressesAndMasks:
{
Description: IP V4 Addresses and masks for the listener. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPV4 address ,
Required: False ,
}
string ,
mask:
{
Description: IPV4 netmask ,
Required: False ,
}
string ,
}
,
]
,
ipV6Addresses:
{
Description: IP V6 Addresses for the listener ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: Network port for the listener. Default is 1433. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
replicas:
{
Description: A list of Availability Group Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Replicas. ,
Required: False ,
}
[
{
replicaId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
replicaName:
{
Description: The replica name. ,
Required: False ,
}
string ,
replicaResourceId:
{
Description: Resource id of this replica. This is required for a distributed availability group, in which case it describes the location of the availability group that hosts one replica in the DAG. In a non-distributed availability group this field is optional but can be used to store the Azure resource id for AG. ,
Format: arm-id ,
Required: False ,
}
string ,
configure:
{
Description: null ,
Required: False ,
}
{
endpointName:
{
Description: Name of the mirroring endpoint URL ,
Required: False ,
}
string ,
endpointUrl:
{
Description: Mirroring endpoint URL of availability group replica ,
Required: False ,
}
string ,
endpointAuthenticationMode:
{
Description: Permitted authentication modes for the mirroring endpoint. ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
certificateName:
{
Description: Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified. ,
Required: False ,
}
string ,
endpointConnectLogin:
{
Description: The login which will connect to the mirroring endpoint. ,
Required: False ,
}
string ,
availabilityMode:
{
Description: Property that determines whether a given availability replica can run in synchronous-commit mode ,
Enum:
{
SYNCHRONOUS_COMMIT: No description available. ,
ASYNCHRONOUS_COMMIT: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityModeDescription:
{
Description: The Availability Synchronization mode of the availability group replica. ,
Required: False ,
}
string ,
failoverMode:
{
Description: Property to set the failover mode of the availability group replica ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
EXTERNAL: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
failoverModeDescription:
{
Description: The failover mode of the availability group replica. ,
Required: False ,
}
string ,
sessionTimeout:
{
Description: The time-out period of availability group session replica, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
primaryAllowConnections:
{
Description: Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections) ,
Enum:
{
ALL: No description available. ,
READ_WRITE: No description available. ,
}
,
Required: False ,
}
enum ,
primaryRoleAllowConnectionsDescription:
{
Description: Whether the availability allows all connections or only read-write connections. ,
Required: False ,
}
string ,
secondaryAllowConnections:
{
Description: Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections. ,
Enum:
{
NO: No description available. ,
ALL: No description available. ,
READ_ONLY: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryRoleAllowConnectionsDescription:
{
Description: Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients. ,
Required: False ,
}
string ,
replicaCreateDate:
{
Description: Date that the replica was created. ,
Format: date-time ,
Required: False ,
}
string ,
replicaModifyDate:
{
Description: Date that the replica was modified. ,
Format: date-time ,
Required: False ,
}
string ,
backupPriority:
{
Description: Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. ,
Format: int32 ,
Required: False ,
}
integer ,
readOnlyRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read only availability replica. ,
Required: False ,
}
string ,
readWriteRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read write availability replica. ,
Required: False ,
}
string ,
seedingMode:
{
Description: Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica. ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
}
,
Required: False ,
}
enum ,
seedingModeDescription:
{
Description: Describes seeding mode. ,
Required: False ,
}
string ,
}
,
state:
{
Description: null ,
Required: False ,
}
{
availabilityGroupReplicaRole:
{
Description: Current Always On availability groups role of the availability group replica. ,
Required: False ,
}
string ,
operationalStateDescription:
{
Description: Current operational state of the availability group replica ,
Required: False ,
}
string ,
recoveryHealthDescription:
{
Description: Recovery health of the availability group replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica. ,
Required: False ,
}
string ,
connectedStateDescription:
{
Description: Whether a secondary replica is currently connected to the primary replica. ,
Required: False ,
}
string ,
lastConnectErrorDescription:
{
Description: Text description of the last connection error of the availability group replica. ,
Required: False ,
}
string ,
lastConnectErrorTimestamp:
{
Description: Date and time timestamp indicating when the last connect error occurred. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
databases:
{
Description: A list of Availability Group Database Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Database Replicas. ,
Required: False ,
}
[
{
databaseName:
{
Description: the database name. ,
Required: False ,
}
string ,
replicaName:
{
Description: the database replica name. ,
Required: False ,
}
string ,
isLocal:
{
Description: Whether the availability database is local. ,
Required: False ,
}
boolean ,
isPrimaryReplica:
{
Description: Returns 1 if the replica is primary, or 0 if it is a secondary replica. ,
Required: False ,
}
boolean ,
synchronizationStateDescription:
{
Description: Description of the data-movement state. ,
Required: False ,
}
string ,
isCommitParticipant:
{
Description: Whether this replica is transaction committer. ,
Required: False ,
}
boolean ,
synchronizationHealthDescription:
{
Description: Description of the health of database. ,
Required: False ,
}
string ,
databaseStateDescription:
{
Description: Description of the database state of the availability replica. ,
Required: False ,
}
string ,
isSuspended:
{
Description: Whether this data movement is suspended. ,
Required: False ,
}
boolean ,
suspendReasonDescription:
{
Description: Description of the database suspended state reason. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server availability group resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerAvailabilityGroups_Failover (new)
Description :  Request manual failover of the availability group to this server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}/failover
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
availabilityGroupName:
{
Description: Name of SQL Availability Group ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Arc Sql Server availability group ,
Required: True ,
}
{
availabilityGroupId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
serverName:
{
Description: the SQL server name. ,
Required: False ,
}
string ,
instanceName:
{
Description: the SQL Server Instance name. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
collectionTimestamp:
{
Description: Timestamp for when the data was collected from the client machine. ,
Format: date-time ,
Required: False ,
}
string ,
info:
{
Description: Availability Group Info ,
Required: False ,
}
{
failureConditionLevel:
{
Description: User-defined failure condition level under which an automatic failover must be triggered. ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckTimeout:
{
Description: Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding. ,
Format: int32 ,
Required: False ,
}
integer ,
automatedBackupPreferenceDescription:
{
Description: Preferred location for performing backups on the availability databases in this availability group. ,
Required: False ,
}
string ,
version:
{
Description: SQL Server availability group current version. ,
Format: int32 ,
Required: False ,
}
integer ,
basicFeatures:
{
Description: Specifies whether this is a basic availability group. ,
Required: False ,
}
boolean ,
dtcSupport:
{
Description: Specifies whether DTC support has been enabled for this availability group. ,
Required: False ,
}
boolean ,
dbFailover:
{
Description: Specifies whether the availability group supports failover for database health conditions. ,
Required: False ,
}
boolean ,
isDistributed:
{
Description: Specifies whether this is a distributed availability group. ,
Required: False ,
}
boolean ,
clusterTypeDescription:
{
Description: SQL Server availability group cluster type description ,
Required: False ,
}
string ,
requiredSynchronizedSecondariesToCommit:
{
Description: The number of secondary replicas that must be in a synchronized state for a commit to complete. ,
Format: int32 ,
Required: False ,
}
integer ,
isContained:
{
Description: SQL Server availability group contained system databases. ,
Required: False ,
}
boolean ,
primaryReplica:
{
Description: Name of the server instance that is hosting the current primary replica. ,
Required: False ,
}
string ,
primaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of the primary replica. ,
Required: False ,
}
string ,
secondaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of a secondary replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a roll-up of the synchronization health of all availability replicas in the availability group. ,
Required: False ,
}
string ,
replicationPartnerType:
{
Enum:
{
SQLServer: No description available. ,
AzureSQLVM: No description available. ,
AzureSQLManagedInstance: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
listener:
{
Description: The listener for the sql server availability group ,
Required: False ,
}
{
dnsName:
{
Description: the DNS name for the listener. ,
Required: False ,
}
string ,
ipV4AddressesAndMasks:
{
Description: IP V4 Addresses and masks for the listener. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPV4 address ,
Required: False ,
}
string ,
mask:
{
Description: IPV4 netmask ,
Required: False ,
}
string ,
}
,
]
,
ipV6Addresses:
{
Description: IP V6 Addresses for the listener ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: Network port for the listener. Default is 1433. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
replicas:
{
Description: A list of Availability Group Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Replicas. ,
Required: False ,
}
[
{
replicaId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
replicaName:
{
Description: The replica name. ,
Required: False ,
}
string ,
replicaResourceId:
{
Description: Resource id of this replica. This is required for a distributed availability group, in which case it describes the location of the availability group that hosts one replica in the DAG. In a non-distributed availability group this field is optional but can be used to store the Azure resource id for AG. ,
Format: arm-id ,
Required: False ,
}
string ,
configure:
{
Description: null ,
Required: False ,
}
{
endpointName:
{
Description: Name of the mirroring endpoint URL ,
Required: False ,
}
string ,
endpointUrl:
{
Description: Mirroring endpoint URL of availability group replica ,
Required: False ,
}
string ,
endpointAuthenticationMode:
{
Description: Permitted authentication modes for the mirroring endpoint. ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
certificateName:
{
Description: Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified. ,
Required: False ,
}
string ,
endpointConnectLogin:
{
Description: The login which will connect to the mirroring endpoint. ,
Required: False ,
}
string ,
availabilityMode:
{
Description: Property that determines whether a given availability replica can run in synchronous-commit mode ,
Enum:
{
SYNCHRONOUS_COMMIT: No description available. ,
ASYNCHRONOUS_COMMIT: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityModeDescription:
{
Description: The Availability Synchronization mode of the availability group replica. ,
Required: False ,
}
string ,
failoverMode:
{
Description: Property to set the failover mode of the availability group replica ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
EXTERNAL: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
failoverModeDescription:
{
Description: The failover mode of the availability group replica. ,
Required: False ,
}
string ,
sessionTimeout:
{
Description: The time-out period of availability group session replica, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
primaryAllowConnections:
{
Description: Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections) ,
Enum:
{
ALL: No description available. ,
READ_WRITE: No description available. ,
}
,
Required: False ,
}
enum ,
primaryRoleAllowConnectionsDescription:
{
Description: Whether the availability allows all connections or only read-write connections. ,
Required: False ,
}
string ,
secondaryAllowConnections:
{
Description: Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections. ,
Enum:
{
NO: No description available. ,
ALL: No description available. ,
READ_ONLY: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryRoleAllowConnectionsDescription:
{
Description: Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients. ,
Required: False ,
}
string ,
replicaCreateDate:
{
Description: Date that the replica was created. ,
Format: date-time ,
Required: False ,
}
string ,
replicaModifyDate:
{
Description: Date that the replica was modified. ,
Format: date-time ,
Required: False ,
}
string ,
backupPriority:
{
Description: Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. ,
Format: int32 ,
Required: False ,
}
integer ,
readOnlyRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read only availability replica. ,
Required: False ,
}
string ,
readWriteRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read write availability replica. ,
Required: False ,
}
string ,
seedingMode:
{
Description: Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica. ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
}
,
Required: False ,
}
enum ,
seedingModeDescription:
{
Description: Describes seeding mode. ,
Required: False ,
}
string ,
}
,
state:
{
Description: null ,
Required: False ,
}
{
availabilityGroupReplicaRole:
{
Description: Current Always On availability groups role of the availability group replica. ,
Required: False ,
}
string ,
operationalStateDescription:
{
Description: Current operational state of the availability group replica ,
Required: False ,
}
string ,
recoveryHealthDescription:
{
Description: Recovery health of the availability group replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica. ,
Required: False ,
}
string ,
connectedStateDescription:
{
Description: Whether a secondary replica is currently connected to the primary replica. ,
Required: False ,
}
string ,
lastConnectErrorDescription:
{
Description: Text description of the last connection error of the availability group replica. ,
Required: False ,
}
string ,
lastConnectErrorTimestamp:
{
Description: Date and time timestamp indicating when the last connect error occurred. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
databases:
{
Description: A list of Availability Group Database Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Database Replicas. ,
Required: False ,
}
[
{
databaseName:
{
Description: the database name. ,
Required: False ,
}
string ,
replicaName:
{
Description: the database replica name. ,
Required: False ,
}
string ,
isLocal:
{
Description: Whether the availability database is local. ,
Required: False ,
}
boolean ,
isPrimaryReplica:
{
Description: Returns 1 if the replica is primary, or 0 if it is a secondary replica. ,
Required: False ,
}
boolean ,
synchronizationStateDescription:
{
Description: Description of the data-movement state. ,
Required: False ,
}
string ,
isCommitParticipant:
{
Description: Whether this replica is transaction committer. ,
Required: False ,
}
boolean ,
synchronizationHealthDescription:
{
Description: Description of the health of database. ,
Required: False ,
}
string ,
databaseStateDescription:
{
Description: Description of the database state of the availability replica. ,
Required: False ,
}
string ,
isSuspended:
{
Description: Whether this data movement is suspended. ,
Required: False ,
}
boolean ,
suspendReasonDescription:
{
Description: Description of the database suspended state reason. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server availability group resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerAvailabilityGroups_ForceFailoverAllowDataLoss (new)
Description :  Request forced failover of the availability group to this server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}/forceFailoverAllowDataLoss
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
availabilityGroupName:
{
Description: Name of SQL Availability Group ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Arc Sql Server availability group ,
Required: True ,
}
{
availabilityGroupId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
serverName:
{
Description: the SQL server name. ,
Required: False ,
}
string ,
instanceName:
{
Description: the SQL Server Instance name. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
collectionTimestamp:
{
Description: Timestamp for when the data was collected from the client machine. ,
Format: date-time ,
Required: False ,
}
string ,
info:
{
Description: Availability Group Info ,
Required: False ,
}
{
failureConditionLevel:
{
Description: User-defined failure condition level under which an automatic failover must be triggered. ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckTimeout:
{
Description: Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding. ,
Format: int32 ,
Required: False ,
}
integer ,
automatedBackupPreferenceDescription:
{
Description: Preferred location for performing backups on the availability databases in this availability group. ,
Required: False ,
}
string ,
version:
{
Description: SQL Server availability group current version. ,
Format: int32 ,
Required: False ,
}
integer ,
basicFeatures:
{
Description: Specifies whether this is a basic availability group. ,
Required: False ,
}
boolean ,
dtcSupport:
{
Description: Specifies whether DTC support has been enabled for this availability group. ,
Required: False ,
}
boolean ,
dbFailover:
{
Description: Specifies whether the availability group supports failover for database health conditions. ,
Required: False ,
}
boolean ,
isDistributed:
{
Description: Specifies whether this is a distributed availability group. ,
Required: False ,
}
boolean ,
clusterTypeDescription:
{
Description: SQL Server availability group cluster type description ,
Required: False ,
}
string ,
requiredSynchronizedSecondariesToCommit:
{
Description: The number of secondary replicas that must be in a synchronized state for a commit to complete. ,
Format: int32 ,
Required: False ,
}
integer ,
isContained:
{
Description: SQL Server availability group contained system databases. ,
Required: False ,
}
boolean ,
primaryReplica:
{
Description: Name of the server instance that is hosting the current primary replica. ,
Required: False ,
}
string ,
primaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of the primary replica. ,
Required: False ,
}
string ,
secondaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of a secondary replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a roll-up of the synchronization health of all availability replicas in the availability group. ,
Required: False ,
}
string ,
replicationPartnerType:
{
Enum:
{
SQLServer: No description available. ,
AzureSQLVM: No description available. ,
AzureSQLManagedInstance: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
listener:
{
Description: The listener for the sql server availability group ,
Required: False ,
}
{
dnsName:
{
Description: the DNS name for the listener. ,
Required: False ,
}
string ,
ipV4AddressesAndMasks:
{
Description: IP V4 Addresses and masks for the listener. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPV4 address ,
Required: False ,
}
string ,
mask:
{
Description: IPV4 netmask ,
Required: False ,
}
string ,
}
,
]
,
ipV6Addresses:
{
Description: IP V6 Addresses for the listener ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: Network port for the listener. Default is 1433. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
replicas:
{
Description: A list of Availability Group Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Replicas. ,
Required: False ,
}
[
{
replicaId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
replicaName:
{
Description: The replica name. ,
Required: False ,
}
string ,
replicaResourceId:
{
Description: Resource id of this replica. This is required for a distributed availability group, in which case it describes the location of the availability group that hosts one replica in the DAG. In a non-distributed availability group this field is optional but can be used to store the Azure resource id for AG. ,
Format: arm-id ,
Required: False ,
}
string ,
configure:
{
Description: null ,
Required: False ,
}
{
endpointName:
{
Description: Name of the mirroring endpoint URL ,
Required: False ,
}
string ,
endpointUrl:
{
Description: Mirroring endpoint URL of availability group replica ,
Required: False ,
}
string ,
endpointAuthenticationMode:
{
Description: Permitted authentication modes for the mirroring endpoint. ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
certificateName:
{
Description: Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified. ,
Required: False ,
}
string ,
endpointConnectLogin:
{
Description: The login which will connect to the mirroring endpoint. ,
Required: False ,
}
string ,
availabilityMode:
{
Description: Property that determines whether a given availability replica can run in synchronous-commit mode ,
Enum:
{
SYNCHRONOUS_COMMIT: No description available. ,
ASYNCHRONOUS_COMMIT: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityModeDescription:
{
Description: The Availability Synchronization mode of the availability group replica. ,
Required: False ,
}
string ,
failoverMode:
{
Description: Property to set the failover mode of the availability group replica ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
EXTERNAL: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
failoverModeDescription:
{
Description: The failover mode of the availability group replica. ,
Required: False ,
}
string ,
sessionTimeout:
{
Description: The time-out period of availability group session replica, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
primaryAllowConnections:
{
Description: Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections) ,
Enum:
{
ALL: No description available. ,
READ_WRITE: No description available. ,
}
,
Required: False ,
}
enum ,
primaryRoleAllowConnectionsDescription:
{
Description: Whether the availability allows all connections or only read-write connections. ,
Required: False ,
}
string ,
secondaryAllowConnections:
{
Description: Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections. ,
Enum:
{
NO: No description available. ,
ALL: No description available. ,
READ_ONLY: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryRoleAllowConnectionsDescription:
{
Description: Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients. ,
Required: False ,
}
string ,
replicaCreateDate:
{
Description: Date that the replica was created. ,
Format: date-time ,
Required: False ,
}
string ,
replicaModifyDate:
{
Description: Date that the replica was modified. ,
Format: date-time ,
Required: False ,
}
string ,
backupPriority:
{
Description: Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. ,
Format: int32 ,
Required: False ,
}
integer ,
readOnlyRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read only availability replica. ,
Required: False ,
}
string ,
readWriteRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read write availability replica. ,
Required: False ,
}
string ,
seedingMode:
{
Description: Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica. ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
}
,
Required: False ,
}
enum ,
seedingModeDescription:
{
Description: Describes seeding mode. ,
Required: False ,
}
string ,
}
,
state:
{
Description: null ,
Required: False ,
}
{
availabilityGroupReplicaRole:
{
Description: Current Always On availability groups role of the availability group replica. ,
Required: False ,
}
string ,
operationalStateDescription:
{
Description: Current operational state of the availability group replica ,
Required: False ,
}
string ,
recoveryHealthDescription:
{
Description: Recovery health of the availability group replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica. ,
Required: False ,
}
string ,
connectedStateDescription:
{
Description: Whether a secondary replica is currently connected to the primary replica. ,
Required: False ,
}
string ,
lastConnectErrorDescription:
{
Description: Text description of the last connection error of the availability group replica. ,
Required: False ,
}
string ,
lastConnectErrorTimestamp:
{
Description: Date and time timestamp indicating when the last connect error occurred. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
databases:
{
Description: A list of Availability Group Database Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Database Replicas. ,
Required: False ,
}
[
{
databaseName:
{
Description: the database name. ,
Required: False ,
}
string ,
replicaName:
{
Description: the database replica name. ,
Required: False ,
}
string ,
isLocal:
{
Description: Whether the availability database is local. ,
Required: False ,
}
boolean ,
isPrimaryReplica:
{
Description: Returns 1 if the replica is primary, or 0 if it is a secondary replica. ,
Required: False ,
}
boolean ,
synchronizationStateDescription:
{
Description: Description of the data-movement state. ,
Required: False ,
}
string ,
isCommitParticipant:
{
Description: Whether this replica is transaction committer. ,
Required: False ,
}
boolean ,
synchronizationHealthDescription:
{
Description: Description of the health of database. ,
Required: False ,
}
string ,
databaseStateDescription:
{
Description: Description of the database state of the availability replica. ,
Required: False ,
}
string ,
isSuspended:
{
Description: Whether this data movement is suspended. ,
Required: False ,
}
boolean ,
suspendReasonDescription:
{
Description: Description of the database suspended state reason. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server availability group resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerAvailabilityGroups_CreateAvailabilityGroup (new)
Description :  Create a SQL Server availability group
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/createAvailabilityGroup
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createAgConfiguration:
{
Description: The configuration for the new SQL Server availability group resource. ,
Required: True ,
}
{
availabilityGroupName:
{
Description: Name of the availability group. ,
Required: False ,
}
string ,
replicas:
{
Description: List of availability group replicas. ,
Required: False ,
}
[
{
serverInstance:
{
Description: the server instance hosting the replica. ,
Required: False ,
}
string ,
endpointName:
{
Description: Name of the database mirroring endpoint URL for the availability group replica ,
Required: False ,
}
string ,
endpointUrl:
{
Description: Database mirroring endpoint URL of availability group replica ,
Required: False ,
}
string ,
endpointAuthenticationMode:
{
Description: Permitted authentication modes for the mirroring endpoint. ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
certificateName:
{
Description: Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified. ,
Required: False ,
}
string ,
endpointConnectLogin:
{
Description: The login which will connect to the mirroring endpoint ,
Required: False ,
}
string ,
availabilityMode:
{
Description: Property that determines whether a given availability replica can run in synchronous-commit mode ,
Enum:
{
SYNCHRONOUS_COMMIT: No description available. ,
ASYNCHRONOUS_COMMIT: No description available. ,
}
,
Required: False ,
}
enum ,
failoverMode:
{
Description: Property to set the failover mode of the availability group replica ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
EXTERNAL: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
seedingMode:
{
Description: Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica. ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
}
,
Required: False ,
}
enum ,
backupPriority:
{
Description: Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryRoleAllowConnections:
{
Description: Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections. ,
Enum:
{
NO: No description available. ,
ALL: No description available. ,
READ_ONLY: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryRoleReadOnlyRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read only availability replica. ,
Required: False ,
}
string ,
primaryRoleAllowConnections:
{
Description: Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections) ,
Enum:
{
ALL: No description available. ,
READ_WRITE: No description available. ,
}
,
Required: False ,
}
enum ,
primaryRoleReadOnlyRoutingList:
{
Description: List of read only routing URLs. ,
Required: False ,
}
[
string ,
]
,
sessionTimeout:
{
Description: The time-out period of availability group session replica, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
databases:
{
Description: List of databases to include in the availability group. ,
Required: False ,
}
[
string ,
]
,
automatedBackupPreference:
{
Description: Preferred replica for running automated backups. ,
Enum:
{
PRIMARY: No description available. ,
SECONDARY_ONLY: No description available. ,
SECONDARY: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
failureConditionLevel:
{
Description: User-defined failure condition level under which an automatic failover must be triggered. ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckTimeout:
{
Description: Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding. ,
Format: int32 ,
Required: False ,
}
integer ,
dbFailover:
{
Description: Specifies whether the availability group supports failover for database health conditions. ,
Enum:
{
ON: No description available. ,
OFF: No description available. ,
}
,
Required: False ,
}
enum ,
dtcSupport:
{
Description: Specifies whether DTC support has been enabled for this availability group. ,
Enum:
{
PER_DB: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
requiredSynchronizedSecondariesToCommit:
{
Description: The number of secondary replicas that must be in a synchronized state for a commit to complete. ,
Format: int32 ,
Required: False ,
}
integer ,
clusterType:
{
Description: Set to WSFC when availability group is on a failover cluster instance on a Windows Server failover cluster. Set to NONE when availability group not using WSFC for cluster coordination. ,
Enum:
{
WSFC: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
listener:
{
Description: The listener for the sql server availability group ,
Required: False ,
}
{
dnsName:
{
Description: the DNS name for the listener. ,
Required: False ,
}
string ,
ipV4AddressesAndMasks:
{
Description: IP V4 Addresses and masks for the listener. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPV4 address ,
Required: False ,
}
string ,
mask:
{
Description: IPV4 netmask ,
Required: False ,
}
string ,
}
,
]
,
ipV6Addresses:
{
Description: IP V6 Addresses for the listener ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: Network port for the listener. Default is 1433. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Arc Sql Server availability group ,
Required: True ,
}
{
availabilityGroupId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
serverName:
{
Description: the SQL server name. ,
Required: False ,
}
string ,
instanceName:
{
Description: the SQL Server Instance name. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
collectionTimestamp:
{
Description: Timestamp for when the data was collected from the client machine. ,
Format: date-time ,
Required: False ,
}
string ,
info:
{
Description: Availability Group Info ,
Required: False ,
}
{
failureConditionLevel:
{
Description: User-defined failure condition level under which an automatic failover must be triggered. ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckTimeout:
{
Description: Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding. ,
Format: int32 ,
Required: False ,
}
integer ,
automatedBackupPreferenceDescription:
{
Description: Preferred location for performing backups on the availability databases in this availability group. ,
Required: False ,
}
string ,
version:
{
Description: SQL Server availability group current version. ,
Format: int32 ,
Required: False ,
}
integer ,
basicFeatures:
{
Description: Specifies whether this is a basic availability group. ,
Required: False ,
}
boolean ,
dtcSupport:
{
Description: Specifies whether DTC support has been enabled for this availability group. ,
Required: False ,
}
boolean ,
dbFailover:
{
Description: Specifies whether the availability group supports failover for database health conditions. ,
Required: False ,
}
boolean ,
isDistributed:
{
Description: Specifies whether this is a distributed availability group. ,
Required: False ,
}
boolean ,
clusterTypeDescription:
{
Description: SQL Server availability group cluster type description ,
Required: False ,
}
string ,
requiredSynchronizedSecondariesToCommit:
{
Description: The number of secondary replicas that must be in a synchronized state for a commit to complete. ,
Format: int32 ,
Required: False ,
}
integer ,
isContained:
{
Description: SQL Server availability group contained system databases. ,
Required: False ,
}
boolean ,
primaryReplica:
{
Description: Name of the server instance that is hosting the current primary replica. ,
Required: False ,
}
string ,
primaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of the primary replica. ,
Required: False ,
}
string ,
secondaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of a secondary replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a roll-up of the synchronization health of all availability replicas in the availability group. ,
Required: False ,
}
string ,
replicationPartnerType:
{
Enum:
{
SQLServer: No description available. ,
AzureSQLVM: No description available. ,
AzureSQLManagedInstance: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
listener:
{
Description: The listener for the sql server availability group ,
Required: False ,
}
{
dnsName:
{
Description: the DNS name for the listener. ,
Required: False ,
}
string ,
ipV4AddressesAndMasks:
{
Description: IP V4 Addresses and masks for the listener. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPV4 address ,
Required: False ,
}
string ,
mask:
{
Description: IPV4 netmask ,
Required: False ,
}
string ,
}
,
]
,
ipV6Addresses:
{
Description: IP V6 Addresses for the listener ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: Network port for the listener. Default is 1433. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
replicas:
{
Description: A list of Availability Group Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Replicas. ,
Required: False ,
}
[
{
replicaId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
replicaName:
{
Description: The replica name. ,
Required: False ,
}
string ,
replicaResourceId:
{
Description: Resource id of this replica. This is required for a distributed availability group, in which case it describes the location of the availability group that hosts one replica in the DAG. In a non-distributed availability group this field is optional but can be used to store the Azure resource id for AG. ,
Format: arm-id ,
Required: False ,
}
string ,
configure:
{
Description: null ,
Required: False ,
}
{
endpointName:
{
Description: Name of the mirroring endpoint URL ,
Required: False ,
}
string ,
endpointUrl:
{
Description: Mirroring endpoint URL of availability group replica ,
Required: False ,
}
string ,
endpointAuthenticationMode:
{
Description: Permitted authentication modes for the mirroring endpoint. ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
certificateName:
{
Description: Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified. ,
Required: False ,
}
string ,
endpointConnectLogin:
{
Description: The login which will connect to the mirroring endpoint. ,
Required: False ,
}
string ,
availabilityMode:
{
Description: Property that determines whether a given availability replica can run in synchronous-commit mode ,
Enum:
{
SYNCHRONOUS_COMMIT: No description available. ,
ASYNCHRONOUS_COMMIT: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityModeDescription:
{
Description: The Availability Synchronization mode of the availability group replica. ,
Required: False ,
}
string ,
failoverMode:
{
Description: Property to set the failover mode of the availability group replica ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
EXTERNAL: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
failoverModeDescription:
{
Description: The failover mode of the availability group replica. ,
Required: False ,
}
string ,
sessionTimeout:
{
Description: The time-out period of availability group session replica, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
primaryAllowConnections:
{
Description: Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections) ,
Enum:
{
ALL: No description available. ,
READ_WRITE: No description available. ,
}
,
Required: False ,
}
enum ,
primaryRoleAllowConnectionsDescription:
{
Description: Whether the availability allows all connections or only read-write connections. ,
Required: False ,
}
string ,
secondaryAllowConnections:
{
Description: Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections. ,
Enum:
{
NO: No description available. ,
ALL: No description available. ,
READ_ONLY: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryRoleAllowConnectionsDescription:
{
Description: Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients. ,
Required: False ,
}
string ,
replicaCreateDate:
{
Description: Date that the replica was created. ,
Format: date-time ,
Required: False ,
}
string ,
replicaModifyDate:
{
Description: Date that the replica was modified. ,
Format: date-time ,
Required: False ,
}
string ,
backupPriority:
{
Description: Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. ,
Format: int32 ,
Required: False ,
}
integer ,
readOnlyRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read only availability replica. ,
Required: False ,
}
string ,
readWriteRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read write availability replica. ,
Required: False ,
}
string ,
seedingMode:
{
Description: Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica. ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
}
,
Required: False ,
}
enum ,
seedingModeDescription:
{
Description: Describes seeding mode. ,
Required: False ,
}
string ,
}
,
state:
{
Description: null ,
Required: False ,
}
{
availabilityGroupReplicaRole:
{
Description: Current Always On availability groups role of the availability group replica. ,
Required: False ,
}
string ,
operationalStateDescription:
{
Description: Current operational state of the availability group replica ,
Required: False ,
}
string ,
recoveryHealthDescription:
{
Description: Recovery health of the availability group replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica. ,
Required: False ,
}
string ,
connectedStateDescription:
{
Description: Whether a secondary replica is currently connected to the primary replica. ,
Required: False ,
}
string ,
lastConnectErrorDescription:
{
Description: Text description of the last connection error of the availability group replica. ,
Required: False ,
}
string ,
lastConnectErrorTimestamp:
{
Description: Date and time timestamp indicating when the last connect error occurred. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
databases:
{
Description: A list of Availability Group Database Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Database Replicas. ,
Required: False ,
}
[
{
databaseName:
{
Description: the database name. ,
Required: False ,
}
string ,
replicaName:
{
Description: the database replica name. ,
Required: False ,
}
string ,
isLocal:
{
Description: Whether the availability database is local. ,
Required: False ,
}
boolean ,
isPrimaryReplica:
{
Description: Returns 1 if the replica is primary, or 0 if it is a secondary replica. ,
Required: False ,
}
boolean ,
synchronizationStateDescription:
{
Description: Description of the data-movement state. ,
Required: False ,
}
string ,
isCommitParticipant:
{
Description: Whether this replica is transaction committer. ,
Required: False ,
}
boolean ,
synchronizationHealthDescription:
{
Description: Description of the health of database. ,
Required: False ,
}
string ,
databaseStateDescription:
{
Description: Description of the database state of the availability replica. ,
Required: False ,
}
string ,
isSuspended:
{
Description: Whether this data movement is suspended. ,
Required: False ,
}
boolean ,
suspendReasonDescription:
{
Description: Description of the database suspended state reason. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server availability group resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerAvailabilityGroups_CreateDistributedAvailabilityGroup (new)
Description :  Create a SQL Server distributed availability group
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/createDistributedAvailabilityGroup
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createDagConfiguration:
{
Description: The configuration for the new SQL Server availability group resource. ,
Required: True ,
}
{
availabilityGroupName:
{
Description: Name of the availability group. ,
Required: False ,
}
string ,
primaryAvailabilityGroup:
{
Description: The initial primary availability group for the distributed availability group. ,
Required: False ,
}
{
availabilityGroup:
{
Description: The azure resource identifier for the availability group. ,
Format: arm-id ,
Required: False ,
}
string ,
listenerUrl:
{
Description: The listener URL of the availability group. ,
Format: uri ,
Required: False ,
}
string ,
availabilityMode:
{
Description: The availability mode of the availability group. ,
Enum:
{
SYNCHRONOUS_COMMIT: No description available. ,
ASYNCHRONOUS_COMMIT: No description available. ,
}
,
Required: False ,
}
enum ,
failoverMode:
{
Description: The failover mode of the availability group. ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
EXTERNAL: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
seedingMode:
{
Description: The seeding mode of the availability group. ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
}
,
Required: False ,
}
enum ,
certificateConfiguration:
{
Description: The certificate configuration for the availability group. ,
Required: False ,
}
{
certificateName:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
}
,
secondaryAvailabilityGroup:
{
Description: The initial secondary availability group for the distributed availability group. ,
Required: False ,
}
{
availabilityGroup:
{
Description: The azure resource identifier for the availability group. ,
Format: arm-id ,
Required: False ,
}
string ,
listenerUrl:
{
Description: The listener URL of the availability group. ,
Format: uri ,
Required: False ,
}
string ,
availabilityMode:
{
Description: The availability mode of the availability group. ,
Enum:
{
SYNCHRONOUS_COMMIT: No description available. ,
ASYNCHRONOUS_COMMIT: No description available. ,
}
,
Required: False ,
}
enum ,
failoverMode:
{
Description: The failover mode of the availability group. ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
EXTERNAL: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
seedingMode:
{
Description: The seeding mode of the availability group. ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
}
,
Required: False ,
}
enum ,
certificateConfiguration:
{
Description: The certificate configuration for the availability group. ,
Required: False ,
}
{
certificateName:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Arc Sql Server availability group ,
Required: True ,
}
{
availabilityGroupId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
serverName:
{
Description: the SQL server name. ,
Required: False ,
}
string ,
instanceName:
{
Description: the SQL Server Instance name. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
collectionTimestamp:
{
Description: Timestamp for when the data was collected from the client machine. ,
Format: date-time ,
Required: False ,
}
string ,
info:
{
Description: Availability Group Info ,
Required: False ,
}
{
failureConditionLevel:
{
Description: User-defined failure condition level under which an automatic failover must be triggered. ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckTimeout:
{
Description: Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding. ,
Format: int32 ,
Required: False ,
}
integer ,
automatedBackupPreferenceDescription:
{
Description: Preferred location for performing backups on the availability databases in this availability group. ,
Required: False ,
}
string ,
version:
{
Description: SQL Server availability group current version. ,
Format: int32 ,
Required: False ,
}
integer ,
basicFeatures:
{
Description: Specifies whether this is a basic availability group. ,
Required: False ,
}
boolean ,
dtcSupport:
{
Description: Specifies whether DTC support has been enabled for this availability group. ,
Required: False ,
}
boolean ,
dbFailover:
{
Description: Specifies whether the availability group supports failover for database health conditions. ,
Required: False ,
}
boolean ,
isDistributed:
{
Description: Specifies whether this is a distributed availability group. ,
Required: False ,
}
boolean ,
clusterTypeDescription:
{
Description: SQL Server availability group cluster type description ,
Required: False ,
}
string ,
requiredSynchronizedSecondariesToCommit:
{
Description: The number of secondary replicas that must be in a synchronized state for a commit to complete. ,
Format: int32 ,
Required: False ,
}
integer ,
isContained:
{
Description: SQL Server availability group contained system databases. ,
Required: False ,
}
boolean ,
primaryReplica:
{
Description: Name of the server instance that is hosting the current primary replica. ,
Required: False ,
}
string ,
primaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of the primary replica. ,
Required: False ,
}
string ,
secondaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of a secondary replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a roll-up of the synchronization health of all availability replicas in the availability group. ,
Required: False ,
}
string ,
replicationPartnerType:
{
Enum:
{
SQLServer: No description available. ,
AzureSQLVM: No description available. ,
AzureSQLManagedInstance: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
listener:
{
Description: The listener for the sql server availability group ,
Required: False ,
}
{
dnsName:
{
Description: the DNS name for the listener. ,
Required: False ,
}
string ,
ipV4AddressesAndMasks:
{
Description: IP V4 Addresses and masks for the listener. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPV4 address ,
Required: False ,
}
string ,
mask:
{
Description: IPV4 netmask ,
Required: False ,
}
string ,
}
,
]
,
ipV6Addresses:
{
Description: IP V6 Addresses for the listener ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: Network port for the listener. Default is 1433. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
replicas:
{
Description: A list of Availability Group Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Replicas. ,
Required: False ,
}
[
{
replicaId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
replicaName:
{
Description: The replica name. ,
Required: False ,
}
string ,
replicaResourceId:
{
Description: Resource id of this replica. This is required for a distributed availability group, in which case it describes the location of the availability group that hosts one replica in the DAG. In a non-distributed availability group this field is optional but can be used to store the Azure resource id for AG. ,
Format: arm-id ,
Required: False ,
}
string ,
configure:
{
Description: null ,
Required: False ,
}
{
endpointName:
{
Description: Name of the mirroring endpoint URL ,
Required: False ,
}
string ,
endpointUrl:
{
Description: Mirroring endpoint URL of availability group replica ,
Required: False ,
}
string ,
endpointAuthenticationMode:
{
Description: Permitted authentication modes for the mirroring endpoint. ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
certificateName:
{
Description: Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified. ,
Required: False ,
}
string ,
endpointConnectLogin:
{
Description: The login which will connect to the mirroring endpoint. ,
Required: False ,
}
string ,
availabilityMode:
{
Description: Property that determines whether a given availability replica can run in synchronous-commit mode ,
Enum:
{
SYNCHRONOUS_COMMIT: No description available. ,
ASYNCHRONOUS_COMMIT: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityModeDescription:
{
Description: The Availability Synchronization mode of the availability group replica. ,
Required: False ,
}
string ,
failoverMode:
{
Description: Property to set the failover mode of the availability group replica ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
EXTERNAL: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
failoverModeDescription:
{
Description: The failover mode of the availability group replica. ,
Required: False ,
}
string ,
sessionTimeout:
{
Description: The time-out period of availability group session replica, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
primaryAllowConnections:
{
Description: Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections) ,
Enum:
{
ALL: No description available. ,
READ_WRITE: No description available. ,
}
,
Required: False ,
}
enum ,
primaryRoleAllowConnectionsDescription:
{
Description: Whether the availability allows all connections or only read-write connections. ,
Required: False ,
}
string ,
secondaryAllowConnections:
{
Description: Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections. ,
Enum:
{
NO: No description available. ,
ALL: No description available. ,
READ_ONLY: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryRoleAllowConnectionsDescription:
{
Description: Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients. ,
Required: False ,
}
string ,
replicaCreateDate:
{
Description: Date that the replica was created. ,
Format: date-time ,
Required: False ,
}
string ,
replicaModifyDate:
{
Description: Date that the replica was modified. ,
Format: date-time ,
Required: False ,
}
string ,
backupPriority:
{
Description: Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. ,
Format: int32 ,
Required: False ,
}
integer ,
readOnlyRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read only availability replica. ,
Required: False ,
}
string ,
readWriteRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read write availability replica. ,
Required: False ,
}
string ,
seedingMode:
{
Description: Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica. ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
}
,
Required: False ,
}
enum ,
seedingModeDescription:
{
Description: Describes seeding mode. ,
Required: False ,
}
string ,
}
,
state:
{
Description: null ,
Required: False ,
}
{
availabilityGroupReplicaRole:
{
Description: Current Always On availability groups role of the availability group replica. ,
Required: False ,
}
string ,
operationalStateDescription:
{
Description: Current operational state of the availability group replica ,
Required: False ,
}
string ,
recoveryHealthDescription:
{
Description: Recovery health of the availability group replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica. ,
Required: False ,
}
string ,
connectedStateDescription:
{
Description: Whether a secondary replica is currently connected to the primary replica. ,
Required: False ,
}
string ,
lastConnectErrorDescription:
{
Description: Text description of the last connection error of the availability group replica. ,
Required: False ,
}
string ,
lastConnectErrorTimestamp:
{
Description: Date and time timestamp indicating when the last connect error occurred. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
databases:
{
Description: A list of Availability Group Database Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Database Replicas. ,
Required: False ,
}
[
{
databaseName:
{
Description: the database name. ,
Required: False ,
}
string ,
replicaName:
{
Description: the database replica name. ,
Required: False ,
}
string ,
isLocal:
{
Description: Whether the availability database is local. ,
Required: False ,
}
boolean ,
isPrimaryReplica:
{
Description: Returns 1 if the replica is primary, or 0 if it is a secondary replica. ,
Required: False ,
}
boolean ,
synchronizationStateDescription:
{
Description: Description of the data-movement state. ,
Required: False ,
}
string ,
isCommitParticipant:
{
Description: Whether this replica is transaction committer. ,
Required: False ,
}
boolean ,
synchronizationHealthDescription:
{
Description: Description of the health of database. ,
Required: False ,
}
string ,
databaseStateDescription:
{
Description: Description of the database state of the availability replica. ,
Required: False ,
}
string ,
isSuspended:
{
Description: Whether this data movement is suspended. ,
Required: False ,
}
boolean ,
suspendReasonDescription:
{
Description: Description of the database suspended state reason. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server availability group resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerAvailabilityGroups_AddDatabases (new)
Description :  Request adding database(s) to an existing availability group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}/addDatabases
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
availabilityGroupName:
{
Description: Name of SQL Availability Group ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
databases:
{
Description: The database names to add to the SQL Server availability group resource. ,
Required: True ,
}
{
values:
{
Description: List of database names. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Arc Sql Server availability group ,
Required: True ,
}
{
availabilityGroupId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
serverName:
{
Description: the SQL server name. ,
Required: False ,
}
string ,
instanceName:
{
Description: the SQL Server Instance name. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
collectionTimestamp:
{
Description: Timestamp for when the data was collected from the client machine. ,
Format: date-time ,
Required: False ,
}
string ,
info:
{
Description: Availability Group Info ,
Required: False ,
}
{
failureConditionLevel:
{
Description: User-defined failure condition level under which an automatic failover must be triggered. ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckTimeout:
{
Description: Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding. ,
Format: int32 ,
Required: False ,
}
integer ,
automatedBackupPreferenceDescription:
{
Description: Preferred location for performing backups on the availability databases in this availability group. ,
Required: False ,
}
string ,
version:
{
Description: SQL Server availability group current version. ,
Format: int32 ,
Required: False ,
}
integer ,
basicFeatures:
{
Description: Specifies whether this is a basic availability group. ,
Required: False ,
}
boolean ,
dtcSupport:
{
Description: Specifies whether DTC support has been enabled for this availability group. ,
Required: False ,
}
boolean ,
dbFailover:
{
Description: Specifies whether the availability group supports failover for database health conditions. ,
Required: False ,
}
boolean ,
isDistributed:
{
Description: Specifies whether this is a distributed availability group. ,
Required: False ,
}
boolean ,
clusterTypeDescription:
{
Description: SQL Server availability group cluster type description ,
Required: False ,
}
string ,
requiredSynchronizedSecondariesToCommit:
{
Description: The number of secondary replicas that must be in a synchronized state for a commit to complete. ,
Format: int32 ,
Required: False ,
}
integer ,
isContained:
{
Description: SQL Server availability group contained system databases. ,
Required: False ,
}
boolean ,
primaryReplica:
{
Description: Name of the server instance that is hosting the current primary replica. ,
Required: False ,
}
string ,
primaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of the primary replica. ,
Required: False ,
}
string ,
secondaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of a secondary replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a roll-up of the synchronization health of all availability replicas in the availability group. ,
Required: False ,
}
string ,
replicationPartnerType:
{
Enum:
{
SQLServer: No description available. ,
AzureSQLVM: No description available. ,
AzureSQLManagedInstance: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
listener:
{
Description: The listener for the sql server availability group ,
Required: False ,
}
{
dnsName:
{
Description: the DNS name for the listener. ,
Required: False ,
}
string ,
ipV4AddressesAndMasks:
{
Description: IP V4 Addresses and masks for the listener. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPV4 address ,
Required: False ,
}
string ,
mask:
{
Description: IPV4 netmask ,
Required: False ,
}
string ,
}
,
]
,
ipV6Addresses:
{
Description: IP V6 Addresses for the listener ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: Network port for the listener. Default is 1433. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
replicas:
{
Description: A list of Availability Group Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Replicas. ,
Required: False ,
}
[
{
replicaId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
replicaName:
{
Description: The replica name. ,
Required: False ,
}
string ,
replicaResourceId:
{
Description: Resource id of this replica. This is required for a distributed availability group, in which case it describes the location of the availability group that hosts one replica in the DAG. In a non-distributed availability group this field is optional but can be used to store the Azure resource id for AG. ,
Format: arm-id ,
Required: False ,
}
string ,
configure:
{
Description: null ,
Required: False ,
}
{
endpointName:
{
Description: Name of the mirroring endpoint URL ,
Required: False ,
}
string ,
endpointUrl:
{
Description: Mirroring endpoint URL of availability group replica ,
Required: False ,
}
string ,
endpointAuthenticationMode:
{
Description: Permitted authentication modes for the mirroring endpoint. ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
certificateName:
{
Description: Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified. ,
Required: False ,
}
string ,
endpointConnectLogin:
{
Description: The login which will connect to the mirroring endpoint. ,
Required: False ,
}
string ,
availabilityMode:
{
Description: Property that determines whether a given availability replica can run in synchronous-commit mode ,
Enum:
{
SYNCHRONOUS_COMMIT: No description available. ,
ASYNCHRONOUS_COMMIT: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityModeDescription:
{
Description: The Availability Synchronization mode of the availability group replica. ,
Required: False ,
}
string ,
failoverMode:
{
Description: Property to set the failover mode of the availability group replica ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
EXTERNAL: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
failoverModeDescription:
{
Description: The failover mode of the availability group replica. ,
Required: False ,
}
string ,
sessionTimeout:
{
Description: The time-out period of availability group session replica, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
primaryAllowConnections:
{
Description: Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections) ,
Enum:
{
ALL: No description available. ,
READ_WRITE: No description available. ,
}
,
Required: False ,
}
enum ,
primaryRoleAllowConnectionsDescription:
{
Description: Whether the availability allows all connections or only read-write connections. ,
Required: False ,
}
string ,
secondaryAllowConnections:
{
Description: Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections. ,
Enum:
{
NO: No description available. ,
ALL: No description available. ,
READ_ONLY: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryRoleAllowConnectionsDescription:
{
Description: Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients. ,
Required: False ,
}
string ,
replicaCreateDate:
{
Description: Date that the replica was created. ,
Format: date-time ,
Required: False ,
}
string ,
replicaModifyDate:
{
Description: Date that the replica was modified. ,
Format: date-time ,
Required: False ,
}
string ,
backupPriority:
{
Description: Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. ,
Format: int32 ,
Required: False ,
}
integer ,
readOnlyRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read only availability replica. ,
Required: False ,
}
string ,
readWriteRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read write availability replica. ,
Required: False ,
}
string ,
seedingMode:
{
Description: Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica. ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
}
,
Required: False ,
}
enum ,
seedingModeDescription:
{
Description: Describes seeding mode. ,
Required: False ,
}
string ,
}
,
state:
{
Description: null ,
Required: False ,
}
{
availabilityGroupReplicaRole:
{
Description: Current Always On availability groups role of the availability group replica. ,
Required: False ,
}
string ,
operationalStateDescription:
{
Description: Current operational state of the availability group replica ,
Required: False ,
}
string ,
recoveryHealthDescription:
{
Description: Recovery health of the availability group replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica. ,
Required: False ,
}
string ,
connectedStateDescription:
{
Description: Whether a secondary replica is currently connected to the primary replica. ,
Required: False ,
}
string ,
lastConnectErrorDescription:
{
Description: Text description of the last connection error of the availability group replica. ,
Required: False ,
}
string ,
lastConnectErrorTimestamp:
{
Description: Date and time timestamp indicating when the last connect error occurred. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
databases:
{
Description: A list of Availability Group Database Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Database Replicas. ,
Required: False ,
}
[
{
databaseName:
{
Description: the database name. ,
Required: False ,
}
string ,
replicaName:
{
Description: the database replica name. ,
Required: False ,
}
string ,
isLocal:
{
Description: Whether the availability database is local. ,
Required: False ,
}
boolean ,
isPrimaryReplica:
{
Description: Returns 1 if the replica is primary, or 0 if it is a secondary replica. ,
Required: False ,
}
boolean ,
synchronizationStateDescription:
{
Description: Description of the data-movement state. ,
Required: False ,
}
string ,
isCommitParticipant:
{
Description: Whether this replica is transaction committer. ,
Required: False ,
}
boolean ,
synchronizationHealthDescription:
{
Description: Description of the health of database. ,
Required: False ,
}
string ,
databaseStateDescription:
{
Description: Description of the database state of the availability replica. ,
Required: False ,
}
string ,
isSuspended:
{
Description: Whether this data movement is suspended. ,
Required: False ,
}
boolean ,
suspendReasonDescription:
{
Description: Description of the database suspended state reason. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server availability group resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerAvailabilityGroups_RemoveDatabases (new)
Description :  Request removing database(s) from an existing availability group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}/removeDatabases
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
availabilityGroupName:
{
Description: Name of SQL Availability Group ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
databases:
{
Description: The database names to remove from the SQL Server availability group resource. ,
Required: True ,
}
{
values:
{
Description: List of database names. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Arc Sql Server availability group ,
Required: True ,
}
{
availabilityGroupId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
serverName:
{
Description: the SQL server name. ,
Required: False ,
}
string ,
instanceName:
{
Description: the SQL Server Instance name. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
collectionTimestamp:
{
Description: Timestamp for when the data was collected from the client machine. ,
Format: date-time ,
Required: False ,
}
string ,
info:
{
Description: Availability Group Info ,
Required: False ,
}
{
failureConditionLevel:
{
Description: User-defined failure condition level under which an automatic failover must be triggered. ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckTimeout:
{
Description: Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding. ,
Format: int32 ,
Required: False ,
}
integer ,
automatedBackupPreferenceDescription:
{
Description: Preferred location for performing backups on the availability databases in this availability group. ,
Required: False ,
}
string ,
version:
{
Description: SQL Server availability group current version. ,
Format: int32 ,
Required: False ,
}
integer ,
basicFeatures:
{
Description: Specifies whether this is a basic availability group. ,
Required: False ,
}
boolean ,
dtcSupport:
{
Description: Specifies whether DTC support has been enabled for this availability group. ,
Required: False ,
}
boolean ,
dbFailover:
{
Description: Specifies whether the availability group supports failover for database health conditions. ,
Required: False ,
}
boolean ,
isDistributed:
{
Description: Specifies whether this is a distributed availability group. ,
Required: False ,
}
boolean ,
clusterTypeDescription:
{
Description: SQL Server availability group cluster type description ,
Required: False ,
}
string ,
requiredSynchronizedSecondariesToCommit:
{
Description: The number of secondary replicas that must be in a synchronized state for a commit to complete. ,
Format: int32 ,
Required: False ,
}
integer ,
isContained:
{
Description: SQL Server availability group contained system databases. ,
Required: False ,
}
boolean ,
primaryReplica:
{
Description: Name of the server instance that is hosting the current primary replica. ,
Required: False ,
}
string ,
primaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of the primary replica. ,
Required: False ,
}
string ,
secondaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of a secondary replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a roll-up of the synchronization health of all availability replicas in the availability group. ,
Required: False ,
}
string ,
replicationPartnerType:
{
Enum:
{
SQLServer: No description available. ,
AzureSQLVM: No description available. ,
AzureSQLManagedInstance: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
listener:
{
Description: The listener for the sql server availability group ,
Required: False ,
}
{
dnsName:
{
Description: the DNS name for the listener. ,
Required: False ,
}
string ,
ipV4AddressesAndMasks:
{
Description: IP V4 Addresses and masks for the listener. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPV4 address ,
Required: False ,
}
string ,
mask:
{
Description: IPV4 netmask ,
Required: False ,
}
string ,
}
,
]
,
ipV6Addresses:
{
Description: IP V6 Addresses for the listener ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: Network port for the listener. Default is 1433. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
replicas:
{
Description: A list of Availability Group Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Replicas. ,
Required: False ,
}
[
{
replicaId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
replicaName:
{
Description: The replica name. ,
Required: False ,
}
string ,
replicaResourceId:
{
Description: Resource id of this replica. This is required for a distributed availability group, in which case it describes the location of the availability group that hosts one replica in the DAG. In a non-distributed availability group this field is optional but can be used to store the Azure resource id for AG. ,
Format: arm-id ,
Required: False ,
}
string ,
configure:
{
Description: null ,
Required: False ,
}
{
endpointName:
{
Description: Name of the mirroring endpoint URL ,
Required: False ,
}
string ,
endpointUrl:
{
Description: Mirroring endpoint URL of availability group replica ,
Required: False ,
}
string ,
endpointAuthenticationMode:
{
Description: Permitted authentication modes for the mirroring endpoint. ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
certificateName:
{
Description: Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified. ,
Required: False ,
}
string ,
endpointConnectLogin:
{
Description: The login which will connect to the mirroring endpoint. ,
Required: False ,
}
string ,
availabilityMode:
{
Description: Property that determines whether a given availability replica can run in synchronous-commit mode ,
Enum:
{
SYNCHRONOUS_COMMIT: No description available. ,
ASYNCHRONOUS_COMMIT: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityModeDescription:
{
Description: The Availability Synchronization mode of the availability group replica. ,
Required: False ,
}
string ,
failoverMode:
{
Description: Property to set the failover mode of the availability group replica ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
EXTERNAL: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
failoverModeDescription:
{
Description: The failover mode of the availability group replica. ,
Required: False ,
}
string ,
sessionTimeout:
{
Description: The time-out period of availability group session replica, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
primaryAllowConnections:
{
Description: Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections) ,
Enum:
{
ALL: No description available. ,
READ_WRITE: No description available. ,
}
,
Required: False ,
}
enum ,
primaryRoleAllowConnectionsDescription:
{
Description: Whether the availability allows all connections or only read-write connections. ,
Required: False ,
}
string ,
secondaryAllowConnections:
{
Description: Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections. ,
Enum:
{
NO: No description available. ,
ALL: No description available. ,
READ_ONLY: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryRoleAllowConnectionsDescription:
{
Description: Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients. ,
Required: False ,
}
string ,
replicaCreateDate:
{
Description: Date that the replica was created. ,
Format: date-time ,
Required: False ,
}
string ,
replicaModifyDate:
{
Description: Date that the replica was modified. ,
Format: date-time ,
Required: False ,
}
string ,
backupPriority:
{
Description: Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. ,
Format: int32 ,
Required: False ,
}
integer ,
readOnlyRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read only availability replica. ,
Required: False ,
}
string ,
readWriteRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read write availability replica. ,
Required: False ,
}
string ,
seedingMode:
{
Description: Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica. ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
}
,
Required: False ,
}
enum ,
seedingModeDescription:
{
Description: Describes seeding mode. ,
Required: False ,
}
string ,
}
,
state:
{
Description: null ,
Required: False ,
}
{
availabilityGroupReplicaRole:
{
Description: Current Always On availability groups role of the availability group replica. ,
Required: False ,
}
string ,
operationalStateDescription:
{
Description: Current operational state of the availability group replica ,
Required: False ,
}
string ,
recoveryHealthDescription:
{
Description: Recovery health of the availability group replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica. ,
Required: False ,
}
string ,
connectedStateDescription:
{
Description: Whether a secondary replica is currently connected to the primary replica. ,
Required: False ,
}
string ,
lastConnectErrorDescription:
{
Description: Text description of the last connection error of the availability group replica. ,
Required: False ,
}
string ,
lastConnectErrorTimestamp:
{
Description: Date and time timestamp indicating when the last connect error occurred. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
databases:
{
Description: A list of Availability Group Database Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Database Replicas. ,
Required: False ,
}
[
{
databaseName:
{
Description: the database name. ,
Required: False ,
}
string ,
replicaName:
{
Description: the database replica name. ,
Required: False ,
}
string ,
isLocal:
{
Description: Whether the availability database is local. ,
Required: False ,
}
boolean ,
isPrimaryReplica:
{
Description: Returns 1 if the replica is primary, or 0 if it is a secondary replica. ,
Required: False ,
}
boolean ,
synchronizationStateDescription:
{
Description: Description of the data-movement state. ,
Required: False ,
}
string ,
isCommitParticipant:
{
Description: Whether this replica is transaction committer. ,
Required: False ,
}
boolean ,
synchronizationHealthDescription:
{
Description: Description of the health of database. ,
Required: False ,
}
string ,
databaseStateDescription:
{
Description: Description of the database state of the availability replica. ,
Required: False ,
}
string ,
isSuspended:
{
Description: Whether this data movement is suspended. ,
Required: False ,
}
boolean ,
suspendReasonDescription:
{
Description: Description of the database suspended state reason. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server availability group resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerAvailabilityGroups_List (new)
Description :  List the availability group associated with the given Arc Sql Server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of Arc Sql Server Availability Groups. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of Arc Sql Server availability group ,
Required: True ,
}
{
availabilityGroupId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
serverName:
{
Description: the SQL server name. ,
Required: False ,
}
string ,
instanceName:
{
Description: the SQL Server Instance name. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
collectionTimestamp:
{
Description: Timestamp for when the data was collected from the client machine. ,
Format: date-time ,
Required: False ,
}
string ,
info:
{
Description: Availability Group Info ,
Required: False ,
}
{
failureConditionLevel:
{
Description: User-defined failure condition level under which an automatic failover must be triggered. ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckTimeout:
{
Description: Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding. ,
Format: int32 ,
Required: False ,
}
integer ,
automatedBackupPreferenceDescription:
{
Description: Preferred location for performing backups on the availability databases in this availability group. ,
Required: False ,
}
string ,
version:
{
Description: SQL Server availability group current version. ,
Format: int32 ,
Required: False ,
}
integer ,
basicFeatures:
{
Description: Specifies whether this is a basic availability group. ,
Required: False ,
}
boolean ,
dtcSupport:
{
Description: Specifies whether DTC support has been enabled for this availability group. ,
Required: False ,
}
boolean ,
dbFailover:
{
Description: Specifies whether the availability group supports failover for database health conditions. ,
Required: False ,
}
boolean ,
isDistributed:
{
Description: Specifies whether this is a distributed availability group. ,
Required: False ,
}
boolean ,
clusterTypeDescription:
{
Description: SQL Server availability group cluster type description ,
Required: False ,
}
string ,
requiredSynchronizedSecondariesToCommit:
{
Description: The number of secondary replicas that must be in a synchronized state for a commit to complete. ,
Format: int32 ,
Required: False ,
}
integer ,
isContained:
{
Description: SQL Server availability group contained system databases. ,
Required: False ,
}
boolean ,
primaryReplica:
{
Description: Name of the server instance that is hosting the current primary replica. ,
Required: False ,
}
string ,
primaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of the primary replica. ,
Required: False ,
}
string ,
secondaryRecoveryHealthDescription:
{
Description: Indicates the recovery health of a secondary replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a roll-up of the synchronization health of all availability replicas in the availability group. ,
Required: False ,
}
string ,
replicationPartnerType:
{
Enum:
{
SQLServer: No description available. ,
AzureSQLVM: No description available. ,
AzureSQLManagedInstance: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
listener:
{
Description: The listener for the sql server availability group ,
Required: False ,
}
{
dnsName:
{
Description: the DNS name for the listener. ,
Required: False ,
}
string ,
ipV4AddressesAndMasks:
{
Description: IP V4 Addresses and masks for the listener. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPV4 address ,
Required: False ,
}
string ,
mask:
{
Description: IPV4 netmask ,
Required: False ,
}
string ,
}
,
]
,
ipV6Addresses:
{
Description: IP V6 Addresses for the listener ,
Required: False ,
}
[
string ,
]
,
port:
{
Description: Network port for the listener. Default is 1433. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
replicas:
{
Description: A list of Availability Group Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Replicas. ,
Required: False ,
}
[
{
replicaId:
{
Description: ID GUID of the availability group. ,
Required: False ,
}
string ,
replicaName:
{
Description: The replica name. ,
Required: False ,
}
string ,
replicaResourceId:
{
Description: Resource id of this replica. This is required for a distributed availability group, in which case it describes the location of the availability group that hosts one replica in the DAG. In a non-distributed availability group this field is optional but can be used to store the Azure resource id for AG. ,
Format: arm-id ,
Required: False ,
}
string ,
configure:
{
Description: null ,
Required: False ,
}
{
endpointName:
{
Description: Name of the mirroring endpoint URL ,
Required: False ,
}
string ,
endpointUrl:
{
Description: Mirroring endpoint URL of availability group replica ,
Required: False ,
}
string ,
endpointAuthenticationMode:
{
Description: Permitted authentication modes for the mirroring endpoint. ,
Enum:
{
Windows_NTLM: No description available. ,
Windows_Kerberos: No description available. ,
Windows_Negotiate: No description available. ,
Certificate: No description available. ,
Windows_NTLM_Certificate: No description available. ,
Windows_Kerberos_Certificate: No description available. ,
Windows_Negotiate_Certificate: No description available. ,
Certificate_Windows_NTLM: No description available. ,
Certificate_Windows_Kerberos: No description available. ,
Certificate_Windows_Negotiate: No description available. ,
}
,
Required: False ,
}
enum ,
certificateName:
{
Description: Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified. ,
Required: False ,
}
string ,
endpointConnectLogin:
{
Description: The login which will connect to the mirroring endpoint. ,
Required: False ,
}
string ,
availabilityMode:
{
Description: Property that determines whether a given availability replica can run in synchronous-commit mode ,
Enum:
{
SYNCHRONOUS_COMMIT: No description available. ,
ASYNCHRONOUS_COMMIT: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityModeDescription:
{
Description: The Availability Synchronization mode of the availability group replica. ,
Required: False ,
}
string ,
failoverMode:
{
Description: Property to set the failover mode of the availability group replica ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
EXTERNAL: No description available. ,
NONE: No description available. ,
}
,
Required: False ,
}
enum ,
failoverModeDescription:
{
Description: The failover mode of the availability group replica. ,
Required: False ,
}
string ,
sessionTimeout:
{
Description: The time-out period of availability group session replica, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
primaryAllowConnections:
{
Description: Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections) ,
Enum:
{
ALL: No description available. ,
READ_WRITE: No description available. ,
}
,
Required: False ,
}
enum ,
primaryRoleAllowConnectionsDescription:
{
Description: Whether the availability allows all connections or only read-write connections. ,
Required: False ,
}
string ,
secondaryAllowConnections:
{
Description: Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections. ,
Enum:
{
NO: No description available. ,
ALL: No description available. ,
READ_ONLY: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryRoleAllowConnectionsDescription:
{
Description: Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients. ,
Required: False ,
}
string ,
replicaCreateDate:
{
Description: Date that the replica was created. ,
Format: date-time ,
Required: False ,
}
string ,
replicaModifyDate:
{
Description: Date that the replica was modified. ,
Format: date-time ,
Required: False ,
}
string ,
backupPriority:
{
Description: Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. ,
Format: int32 ,
Required: False ,
}
integer ,
readOnlyRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read only availability replica. ,
Required: False ,
}
string ,
readWriteRoutingUrl:
{
Description: Connectivity endpoint (URL) of the read write availability replica. ,
Required: False ,
}
string ,
seedingMode:
{
Description: Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica. ,
Enum:
{
AUTOMATIC: No description available. ,
MANUAL: No description available. ,
}
,
Required: False ,
}
enum ,
seedingModeDescription:
{
Description: Describes seeding mode. ,
Required: False ,
}
string ,
}
,
state:
{
Description: null ,
Required: False ,
}
{
availabilityGroupReplicaRole:
{
Description: Current Always On availability groups role of the availability group replica. ,
Required: False ,
}
string ,
operationalStateDescription:
{
Description: Current operational state of the availability group replica ,
Required: False ,
}
string ,
recoveryHealthDescription:
{
Description: Recovery health of the availability group replica. ,
Required: False ,
}
string ,
synchronizationHealthDescription:
{
Description: Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica. ,
Required: False ,
}
string ,
connectedStateDescription:
{
Description: Whether a secondary replica is currently connected to the primary replica. ,
Required: False ,
}
string ,
lastConnectErrorDescription:
{
Description: Text description of the last connection error of the availability group replica. ,
Required: False ,
}
string ,
lastConnectErrorTimestamp:
{
Description: Date and time timestamp indicating when the last connect error occurred. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
databases:
{
Description: A list of Availability Group Database Replicas. ,
Required: False ,
}
{
value:
{
Description: Array of Availability Group Database Replicas. ,
Required: False ,
}
[
{
databaseName:
{
Description: the database name. ,
Required: False ,
}
string ,
replicaName:
{
Description: the database replica name. ,
Required: False ,
}
string ,
isLocal:
{
Description: Whether the availability database is local. ,
Required: False ,
}
boolean ,
isPrimaryReplica:
{
Description: Returns 1 if the replica is primary, or 0 if it is a secondary replica. ,
Required: False ,
}
boolean ,
synchronizationStateDescription:
{
Description: Description of the data-movement state. ,
Required: False ,
}
string ,
isCommitParticipant:
{
Description: Whether this replica is transaction committer. ,
Required: False ,
}
boolean ,
synchronizationHealthDescription:
{
Description: Description of the health of database. ,
Required: False ,
}
string ,
databaseStateDescription:
{
Description: Description of the database state of the availability replica. ,
Required: False ,
}
string ,
isSuspended:
{
Description: Whether this data movement is suspended. ,
Required: False ,
}
boolean ,
suspendReasonDescription:
{
Description: Description of the database suspended state reason. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server availability group resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerDatabases_Create (new)
Description :  Creates or replaces an Arc Sql Server Database.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/databases/{databaseName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerDatabaseResource:
{
Description: The request body for database resource. ,
Required: True ,
}
{
properties:
{
Description: Properties of Arc Sql Server database ,
Required: True ,
}
{
collationName:
{
Description: Collation of the database. ,
Required: False ,
}
string ,
databaseCreationDate:
{
Description: Creation date of the database. ,
Format: date-time ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: Compatibility level of the database ,
Format: int32 ,
Required: False ,
}
integer ,
sizeMB:
{
Description: Size of the database. ,
Format: float ,
Required: False ,
}
number ,
logFileSizeMB:
{
Description: Total size in MB for the log (ldf) files for this database. ,
Format: float ,
Required: False ,
}
number ,
dataFileSizeMB:
{
Description: Total size in MB for the data (mdf and ndf) files for this database. ,
Format: float ,
Required: False ,
}
number ,
spaceAvailableMB:
{
Description: Space left of the database. ,
Format: float ,
Required: False ,
}
number ,
state:
{
Description: State of the database. ,
Enum:
{
Online: No description available. ,
Restoring: No description available. ,
Recovering: No description available. ,
RecoveryPending: No description available. ,
Suspect: No description available. ,
Emergency: No description available. ,
Offline: No description available. ,
Copying: No description available. ,
OfflineSecondary: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: Whether the database is read only or not. ,
Required: False ,
}
boolean ,
recoveryMode:
{
Description: Status of the database. ,
Enum:
{
Full: No description available. ,
Bulk-logged: No description available. ,
Simple: No description available. ,
}
,
Required: False ,
}
enum ,
databaseOptions:
{
Description: List of features that are enabled for the database ,
Required: False ,
}
{
isAutoCloseOn:
{
Required: False ,
}
boolean ,
isAutoShrinkOn:
{
Required: False ,
}
boolean ,
isAutoCreateStatsOn:
{
Required: False ,
}
boolean ,
isAutoUpdateStatsOn:
{
Required: False ,
}
boolean ,
isRemoteDataArchiveEnabled:
{
Required: False ,
}
boolean ,
isMemoryOptimizationEnabled:
{
Required: False ,
}
boolean ,
isEncrypted:
{
Required: False ,
}
boolean ,
isTrustworthyOn:
{
Required: False ,
}
boolean ,
isHekatonFilesOn:
{
Description: Whether the database uses the In-Memory OLTP feature for storing in-memory objects. ,
Required: False ,
}
boolean ,
numberOfHekatonFiles:
{
Description: How many Hekaton files the DB has on disk, if it uses in-memory OLTP objects. ,
Format: int32 ,
Required: False ,
}
number ,
}
,
backupInformation:
{
Required: False ,
}
{
lastFullBackup:
{
Description: Date time of last full backup. ,
Format: date-time ,
Required: False ,
}
string ,
lastLogBackup:
{
Description: Date time of last log backup. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
backupPolicy:
{
Description: The backup profile for the SQL server. ,
Required: False ,
}
{
retentionPeriodDays:
{
Description: The retention period for all the databases in this managed instance. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupDays:
{
Description: The value indicating days between full backups. ,
Format: int32 ,
Required: False ,
}
integer ,
differentialBackupHours:
{
Description: The differential backup interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionLogBackupMinutes:
{
Description: The value indicating minutes between transaction log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
earliestRestoreDate:
{
Description: This records the earliest start date and time that restore is available for this database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
createMode:
{
Description: Database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. sourceDatabaseId and restorePointInTime must be specified. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
}
,
Required: False ,
}
enum ,
sourceDatabaseId:
{
Description: The name of the source database associated with create operation of this database. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server database resource. ,
Required: False ,
}
string ,
lastDatabaseUploadTime:
{
Description: The time when last successful database upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
migration:
{
Description: Migration related configuration. ,
Required: False ,
}
{
assessment:
{
Description: Migration assessments related configuration. ,
Required: False ,
}
{
assessmentUploadTime:
{
Description: The time when Migration Assessment Report upload was last performed. ,
Format: date-time ,
Required: False ,
}
string ,
databaseAssessments:
{
Description: Issues and warnings impacting the migration of Database to particular Azure Migration Target. ,
Required: False ,
}
[
{
appliesToMigrationTargetPlatform:
{
Required: False ,
}
string ,
featureId:
{
Required: False ,
}
string ,
issueCategory:
{
Required: False ,
}
string ,
moreInformation:
{
Required: False ,
}
string ,
}
,
]
,
targetReadiness:
{
Description: The target readiness for migration for this database. ,
Required: False ,
}
{
azureSqlDatabase:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlManagedInstance:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlVirtualMachine:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
}
,
}
,
}
,
}
,
}
,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
databaseName:
{
Description: Name of the database ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Arc Sql Server database ,
Required: True ,
}
{
collationName:
{
Description: Collation of the database. ,
Required: False ,
}
string ,
databaseCreationDate:
{
Description: Creation date of the database. ,
Format: date-time ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: Compatibility level of the database ,
Format: int32 ,
Required: False ,
}
integer ,
sizeMB:
{
Description: Size of the database. ,
Format: float ,
Required: False ,
}
number ,
logFileSizeMB:
{
Description: Total size in MB for the log (ldf) files for this database. ,
Format: float ,
Required: False ,
}
number ,
dataFileSizeMB:
{
Description: Total size in MB for the data (mdf and ndf) files for this database. ,
Format: float ,
Required: False ,
}
number ,
spaceAvailableMB:
{
Description: Space left of the database. ,
Format: float ,
Required: False ,
}
number ,
state:
{
Description: State of the database. ,
Enum:
{
Online: No description available. ,
Restoring: No description available. ,
Recovering: No description available. ,
RecoveryPending: No description available. ,
Suspect: No description available. ,
Emergency: No description available. ,
Offline: No description available. ,
Copying: No description available. ,
OfflineSecondary: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: Whether the database is read only or not. ,
Required: False ,
}
boolean ,
recoveryMode:
{
Description: Status of the database. ,
Enum:
{
Full: No description available. ,
Bulk-logged: No description available. ,
Simple: No description available. ,
}
,
Required: False ,
}
enum ,
databaseOptions:
{
Description: List of features that are enabled for the database ,
Required: False ,
}
{
isAutoCloseOn:
{
Required: False ,
}
boolean ,
isAutoShrinkOn:
{
Required: False ,
}
boolean ,
isAutoCreateStatsOn:
{
Required: False ,
}
boolean ,
isAutoUpdateStatsOn:
{
Required: False ,
}
boolean ,
isRemoteDataArchiveEnabled:
{
Required: False ,
}
boolean ,
isMemoryOptimizationEnabled:
{
Required: False ,
}
boolean ,
isEncrypted:
{
Required: False ,
}
boolean ,
isTrustworthyOn:
{
Required: False ,
}
boolean ,
isHekatonFilesOn:
{
Description: Whether the database uses the In-Memory OLTP feature for storing in-memory objects. ,
Required: False ,
}
boolean ,
numberOfHekatonFiles:
{
Description: How many Hekaton files the DB has on disk, if it uses in-memory OLTP objects. ,
Format: int32 ,
Required: False ,
}
number ,
}
,
backupInformation:
{
Required: False ,
}
{
lastFullBackup:
{
Description: Date time of last full backup. ,
Format: date-time ,
Required: False ,
}
string ,
lastLogBackup:
{
Description: Date time of last log backup. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
backupPolicy:
{
Description: The backup profile for the SQL server. ,
Required: False ,
}
{
retentionPeriodDays:
{
Description: The retention period for all the databases in this managed instance. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupDays:
{
Description: The value indicating days between full backups. ,
Format: int32 ,
Required: False ,
}
integer ,
differentialBackupHours:
{
Description: The differential backup interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionLogBackupMinutes:
{
Description: The value indicating minutes between transaction log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
earliestRestoreDate:
{
Description: This records the earliest start date and time that restore is available for this database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
createMode:
{
Description: Database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. sourceDatabaseId and restorePointInTime must be specified. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
}
,
Required: False ,
}
enum ,
sourceDatabaseId:
{
Description: The name of the source database associated with create operation of this database. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server database resource. ,
Required: False ,
}
string ,
lastDatabaseUploadTime:
{
Description: The time when last successful database upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
migration:
{
Description: Migration related configuration. ,
Required: False ,
}
{
assessment:
{
Description: Migration assessments related configuration. ,
Required: False ,
}
{
assessmentUploadTime:
{
Description: The time when Migration Assessment Report upload was last performed. ,
Format: date-time ,
Required: False ,
}
string ,
databaseAssessments:
{
Description: Issues and warnings impacting the migration of Database to particular Azure Migration Target. ,
Required: False ,
}
[
{
appliesToMigrationTargetPlatform:
{
Required: False ,
}
string ,
featureId:
{
Required: False ,
}
string ,
issueCategory:
{
Required: False ,
}
string ,
moreInformation:
{
Required: False ,
}
string ,
}
,
]
,
targetReadiness:
{
Description: The target readiness for migration for this database. ,
Required: False ,
}
{
azureSqlDatabase:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlManagedInstance:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlVirtualMachine:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
}
,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of Arc Sql Server database ,
Required: True ,
}
{
collationName:
{
Description: Collation of the database. ,
Required: False ,
}
string ,
databaseCreationDate:
{
Description: Creation date of the database. ,
Format: date-time ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: Compatibility level of the database ,
Format: int32 ,
Required: False ,
}
integer ,
sizeMB:
{
Description: Size of the database. ,
Format: float ,
Required: False ,
}
number ,
logFileSizeMB:
{
Description: Total size in MB for the log (ldf) files for this database. ,
Format: float ,
Required: False ,
}
number ,
dataFileSizeMB:
{
Description: Total size in MB for the data (mdf and ndf) files for this database. ,
Format: float ,
Required: False ,
}
number ,
spaceAvailableMB:
{
Description: Space left of the database. ,
Format: float ,
Required: False ,
}
number ,
state:
{
Description: State of the database. ,
Enum:
{
Online: No description available. ,
Restoring: No description available. ,
Recovering: No description available. ,
RecoveryPending: No description available. ,
Suspect: No description available. ,
Emergency: No description available. ,
Offline: No description available. ,
Copying: No description available. ,
OfflineSecondary: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: Whether the database is read only or not. ,
Required: False ,
}
boolean ,
recoveryMode:
{
Description: Status of the database. ,
Enum:
{
Full: No description available. ,
Bulk-logged: No description available. ,
Simple: No description available. ,
}
,
Required: False ,
}
enum ,
databaseOptions:
{
Description: List of features that are enabled for the database ,
Required: False ,
}
{
isAutoCloseOn:
{
Required: False ,
}
boolean ,
isAutoShrinkOn:
{
Required: False ,
}
boolean ,
isAutoCreateStatsOn:
{
Required: False ,
}
boolean ,
isAutoUpdateStatsOn:
{
Required: False ,
}
boolean ,
isRemoteDataArchiveEnabled:
{
Required: False ,
}
boolean ,
isMemoryOptimizationEnabled:
{
Required: False ,
}
boolean ,
isEncrypted:
{
Required: False ,
}
boolean ,
isTrustworthyOn:
{
Required: False ,
}
boolean ,
isHekatonFilesOn:
{
Description: Whether the database uses the In-Memory OLTP feature for storing in-memory objects. ,
Required: False ,
}
boolean ,
numberOfHekatonFiles:
{
Description: How many Hekaton files the DB has on disk, if it uses in-memory OLTP objects. ,
Format: int32 ,
Required: False ,
}
number ,
}
,
backupInformation:
{
Required: False ,
}
{
lastFullBackup:
{
Description: Date time of last full backup. ,
Format: date-time ,
Required: False ,
}
string ,
lastLogBackup:
{
Description: Date time of last log backup. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
backupPolicy:
{
Description: The backup profile for the SQL server. ,
Required: False ,
}
{
retentionPeriodDays:
{
Description: The retention period for all the databases in this managed instance. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupDays:
{
Description: The value indicating days between full backups. ,
Format: int32 ,
Required: False ,
}
integer ,
differentialBackupHours:
{
Description: The differential backup interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionLogBackupMinutes:
{
Description: The value indicating minutes between transaction log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
earliestRestoreDate:
{
Description: This records the earliest start date and time that restore is available for this database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
createMode:
{
Description: Database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. sourceDatabaseId and restorePointInTime must be specified. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
}
,
Required: False ,
}
enum ,
sourceDatabaseId:
{
Description: The name of the source database associated with create operation of this database. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server database resource. ,
Required: False ,
}
string ,
lastDatabaseUploadTime:
{
Description: The time when last successful database upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
migration:
{
Description: Migration related configuration. ,
Required: False ,
}
{
assessment:
{
Description: Migration assessments related configuration. ,
Required: False ,
}
{
assessmentUploadTime:
{
Description: The time when Migration Assessment Report upload was last performed. ,
Format: date-time ,
Required: False ,
}
string ,
databaseAssessments:
{
Description: Issues and warnings impacting the migration of Database to particular Azure Migration Target. ,
Required: False ,
}
[
{
appliesToMigrationTargetPlatform:
{
Required: False ,
}
string ,
featureId:
{
Required: False ,
}
string ,
issueCategory:
{
Required: False ,
}
string ,
moreInformation:
{
Required: False ,
}
string ,
}
,
]
,
targetReadiness:
{
Description: The target readiness for migration for this database. ,
Required: False ,
}
{
azureSqlDatabase:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlManagedInstance:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlVirtualMachine:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerDatabases_Delete (new)
Description :  Deletes an Arc Sql Server database resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/databases/{databaseName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
databaseName:
{
Description: Name of the database ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerDatabases_Get (new)
Description :  Retrieves an Arc Sql Server database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/databases/{databaseName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
databaseName:
{
Description: Name of the database ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Arc Sql Server database ,
Required: True ,
}
{
collationName:
{
Description: Collation of the database. ,
Required: False ,
}
string ,
databaseCreationDate:
{
Description: Creation date of the database. ,
Format: date-time ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: Compatibility level of the database ,
Format: int32 ,
Required: False ,
}
integer ,
sizeMB:
{
Description: Size of the database. ,
Format: float ,
Required: False ,
}
number ,
logFileSizeMB:
{
Description: Total size in MB for the log (ldf) files for this database. ,
Format: float ,
Required: False ,
}
number ,
dataFileSizeMB:
{
Description: Total size in MB for the data (mdf and ndf) files for this database. ,
Format: float ,
Required: False ,
}
number ,
spaceAvailableMB:
{
Description: Space left of the database. ,
Format: float ,
Required: False ,
}
number ,
state:
{
Description: State of the database. ,
Enum:
{
Online: No description available. ,
Restoring: No description available. ,
Recovering: No description available. ,
RecoveryPending: No description available. ,
Suspect: No description available. ,
Emergency: No description available. ,
Offline: No description available. ,
Copying: No description available. ,
OfflineSecondary: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: Whether the database is read only or not. ,
Required: False ,
}
boolean ,
recoveryMode:
{
Description: Status of the database. ,
Enum:
{
Full: No description available. ,
Bulk-logged: No description available. ,
Simple: No description available. ,
}
,
Required: False ,
}
enum ,
databaseOptions:
{
Description: List of features that are enabled for the database ,
Required: False ,
}
{
isAutoCloseOn:
{
Required: False ,
}
boolean ,
isAutoShrinkOn:
{
Required: False ,
}
boolean ,
isAutoCreateStatsOn:
{
Required: False ,
}
boolean ,
isAutoUpdateStatsOn:
{
Required: False ,
}
boolean ,
isRemoteDataArchiveEnabled:
{
Required: False ,
}
boolean ,
isMemoryOptimizationEnabled:
{
Required: False ,
}
boolean ,
isEncrypted:
{
Required: False ,
}
boolean ,
isTrustworthyOn:
{
Required: False ,
}
boolean ,
isHekatonFilesOn:
{
Description: Whether the database uses the In-Memory OLTP feature for storing in-memory objects. ,
Required: False ,
}
boolean ,
numberOfHekatonFiles:
{
Description: How many Hekaton files the DB has on disk, if it uses in-memory OLTP objects. ,
Format: int32 ,
Required: False ,
}
number ,
}
,
backupInformation:
{
Required: False ,
}
{
lastFullBackup:
{
Description: Date time of last full backup. ,
Format: date-time ,
Required: False ,
}
string ,
lastLogBackup:
{
Description: Date time of last log backup. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
backupPolicy:
{
Description: The backup profile for the SQL server. ,
Required: False ,
}
{
retentionPeriodDays:
{
Description: The retention period for all the databases in this managed instance. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupDays:
{
Description: The value indicating days between full backups. ,
Format: int32 ,
Required: False ,
}
integer ,
differentialBackupHours:
{
Description: The differential backup interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionLogBackupMinutes:
{
Description: The value indicating minutes between transaction log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
earliestRestoreDate:
{
Description: This records the earliest start date and time that restore is available for this database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
createMode:
{
Description: Database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. sourceDatabaseId and restorePointInTime must be specified. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
}
,
Required: False ,
}
enum ,
sourceDatabaseId:
{
Description: The name of the source database associated with create operation of this database. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server database resource. ,
Required: False ,
}
string ,
lastDatabaseUploadTime:
{
Description: The time when last successful database upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
migration:
{
Description: Migration related configuration. ,
Required: False ,
}
{
assessment:
{
Description: Migration assessments related configuration. ,
Required: False ,
}
{
assessmentUploadTime:
{
Description: The time when Migration Assessment Report upload was last performed. ,
Format: date-time ,
Required: False ,
}
string ,
databaseAssessments:
{
Description: Issues and warnings impacting the migration of Database to particular Azure Migration Target. ,
Required: False ,
}
[
{
appliesToMigrationTargetPlatform:
{
Required: False ,
}
string ,
featureId:
{
Required: False ,
}
string ,
issueCategory:
{
Required: False ,
}
string ,
moreInformation:
{
Required: False ,
}
string ,
}
,
]
,
targetReadiness:
{
Description: The target readiness for migration for this database. ,
Required: False ,
}
{
azureSqlDatabase:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlManagedInstance:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlVirtualMachine:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerDatabases_Update (new)
Description :  Updates an existing database.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/databases/{databaseName}
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
databaseName:
{
Description: Name of the database ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
sqlServerDatabaseUpdate:
{
Description: The requested database resource state. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The data controller's properties ,
Required: False ,
}
{
collationName:
{
Description: Collation of the database. ,
Required: False ,
}
string ,
databaseCreationDate:
{
Description: Creation date of the database. ,
Format: date-time ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: Compatibility level of the database ,
Format: int32 ,
Required: False ,
}
integer ,
sizeMB:
{
Description: Size of the database. ,
Format: float ,
Required: False ,
}
number ,
logFileSizeMB:
{
Description: Total size in MB for the log (ldf) files for this database. ,
Format: float ,
Required: False ,
}
number ,
dataFileSizeMB:
{
Description: Total size in MB for the data (mdf and ndf) files for this database. ,
Format: float ,
Required: False ,
}
number ,
spaceAvailableMB:
{
Description: Space left of the database. ,
Format: float ,
Required: False ,
}
number ,
state:
{
Description: State of the database. ,
Enum:
{
Online: No description available. ,
Restoring: No description available. ,
Recovering: No description available. ,
RecoveryPending: No description available. ,
Suspect: No description available. ,
Emergency: No description available. ,
Offline: No description available. ,
Copying: No description available. ,
OfflineSecondary: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: Whether the database is read only or not. ,
Required: False ,
}
boolean ,
recoveryMode:
{
Description: Status of the database. ,
Enum:
{
Full: No description available. ,
Bulk-logged: No description available. ,
Simple: No description available. ,
}
,
Required: False ,
}
enum ,
databaseOptions:
{
Description: List of features that are enabled for the database ,
Required: False ,
}
{
isAutoCloseOn:
{
Required: False ,
}
boolean ,
isAutoShrinkOn:
{
Required: False ,
}
boolean ,
isAutoCreateStatsOn:
{
Required: False ,
}
boolean ,
isAutoUpdateStatsOn:
{
Required: False ,
}
boolean ,
isRemoteDataArchiveEnabled:
{
Required: False ,
}
boolean ,
isMemoryOptimizationEnabled:
{
Required: False ,
}
boolean ,
isEncrypted:
{
Required: False ,
}
boolean ,
isTrustworthyOn:
{
Required: False ,
}
boolean ,
isHekatonFilesOn:
{
Description: Whether the database uses the In-Memory OLTP feature for storing in-memory objects. ,
Required: False ,
}
boolean ,
numberOfHekatonFiles:
{
Description: How many Hekaton files the DB has on disk, if it uses in-memory OLTP objects. ,
Format: int32 ,
Required: False ,
}
number ,
}
,
backupInformation:
{
Required: False ,
}
{
lastFullBackup:
{
Description: Date time of last full backup. ,
Format: date-time ,
Required: False ,
}
string ,
lastLogBackup:
{
Description: Date time of last log backup. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
backupPolicy:
{
Description: The backup profile for the SQL server. ,
Required: False ,
}
{
retentionPeriodDays:
{
Description: The retention period for all the databases in this managed instance. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupDays:
{
Description: The value indicating days between full backups. ,
Format: int32 ,
Required: False ,
}
integer ,
differentialBackupHours:
{
Description: The differential backup interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionLogBackupMinutes:
{
Description: The value indicating minutes between transaction log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
earliestRestoreDate:
{
Description: This records the earliest start date and time that restore is available for this database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
createMode:
{
Description: Database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. sourceDatabaseId and restorePointInTime must be specified. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
}
,
Required: False ,
}
enum ,
sourceDatabaseId:
{
Description: The name of the source database associated with create operation of this database. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server database resource. ,
Required: False ,
}
string ,
lastDatabaseUploadTime:
{
Description: The time when last successful database upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
migration:
{
Description: Migration related configuration. ,
Required: False ,
}
{
assessment:
{
Description: Migration assessments related configuration. ,
Required: False ,
}
{
assessmentUploadTime:
{
Description: The time when Migration Assessment Report upload was last performed. ,
Format: date-time ,
Required: False ,
}
string ,
databaseAssessments:
{
Description: Issues and warnings impacting the migration of Database to particular Azure Migration Target. ,
Required: False ,
}
[
{
appliesToMigrationTargetPlatform:
{
Required: False ,
}
string ,
featureId:
{
Required: False ,
}
string ,
issueCategory:
{
Required: False ,
}
string ,
moreInformation:
{
Required: False ,
}
string ,
}
,
]
,
targetReadiness:
{
Description: The target readiness for migration for this database. ,
Required: False ,
}
{
azureSqlDatabase:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlManagedInstance:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlVirtualMachine:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
}
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Arc Sql Server database ,
Required: True ,
}
{
collationName:
{
Description: Collation of the database. ,
Required: False ,
}
string ,
databaseCreationDate:
{
Description: Creation date of the database. ,
Format: date-time ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: Compatibility level of the database ,
Format: int32 ,
Required: False ,
}
integer ,
sizeMB:
{
Description: Size of the database. ,
Format: float ,
Required: False ,
}
number ,
logFileSizeMB:
{
Description: Total size in MB for the log (ldf) files for this database. ,
Format: float ,
Required: False ,
}
number ,
dataFileSizeMB:
{
Description: Total size in MB for the data (mdf and ndf) files for this database. ,
Format: float ,
Required: False ,
}
number ,
spaceAvailableMB:
{
Description: Space left of the database. ,
Format: float ,
Required: False ,
}
number ,
state:
{
Description: State of the database. ,
Enum:
{
Online: No description available. ,
Restoring: No description available. ,
Recovering: No description available. ,
RecoveryPending: No description available. ,
Suspect: No description available. ,
Emergency: No description available. ,
Offline: No description available. ,
Copying: No description available. ,
OfflineSecondary: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: Whether the database is read only or not. ,
Required: False ,
}
boolean ,
recoveryMode:
{
Description: Status of the database. ,
Enum:
{
Full: No description available. ,
Bulk-logged: No description available. ,
Simple: No description available. ,
}
,
Required: False ,
}
enum ,
databaseOptions:
{
Description: List of features that are enabled for the database ,
Required: False ,
}
{
isAutoCloseOn:
{
Required: False ,
}
boolean ,
isAutoShrinkOn:
{
Required: False ,
}
boolean ,
isAutoCreateStatsOn:
{
Required: False ,
}
boolean ,
isAutoUpdateStatsOn:
{
Required: False ,
}
boolean ,
isRemoteDataArchiveEnabled:
{
Required: False ,
}
boolean ,
isMemoryOptimizationEnabled:
{
Required: False ,
}
boolean ,
isEncrypted:
{
Required: False ,
}
boolean ,
isTrustworthyOn:
{
Required: False ,
}
boolean ,
isHekatonFilesOn:
{
Description: Whether the database uses the In-Memory OLTP feature for storing in-memory objects. ,
Required: False ,
}
boolean ,
numberOfHekatonFiles:
{
Description: How many Hekaton files the DB has on disk, if it uses in-memory OLTP objects. ,
Format: int32 ,
Required: False ,
}
number ,
}
,
backupInformation:
{
Required: False ,
}
{
lastFullBackup:
{
Description: Date time of last full backup. ,
Format: date-time ,
Required: False ,
}
string ,
lastLogBackup:
{
Description: Date time of last log backup. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
backupPolicy:
{
Description: The backup profile for the SQL server. ,
Required: False ,
}
{
retentionPeriodDays:
{
Description: The retention period for all the databases in this managed instance. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupDays:
{
Description: The value indicating days between full backups. ,
Format: int32 ,
Required: False ,
}
integer ,
differentialBackupHours:
{
Description: The differential backup interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionLogBackupMinutes:
{
Description: The value indicating minutes between transaction log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
earliestRestoreDate:
{
Description: This records the earliest start date and time that restore is available for this database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
createMode:
{
Description: Database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. sourceDatabaseId and restorePointInTime must be specified. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
}
,
Required: False ,
}
enum ,
sourceDatabaseId:
{
Description: The name of the source database associated with create operation of this database. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server database resource. ,
Required: False ,
}
string ,
lastDatabaseUploadTime:
{
Description: The time when last successful database upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
migration:
{
Description: Migration related configuration. ,
Required: False ,
}
{
assessment:
{
Description: Migration assessments related configuration. ,
Required: False ,
}
{
assessmentUploadTime:
{
Description: The time when Migration Assessment Report upload was last performed. ,
Format: date-time ,
Required: False ,
}
string ,
databaseAssessments:
{
Description: Issues and warnings impacting the migration of Database to particular Azure Migration Target. ,
Required: False ,
}
[
{
appliesToMigrationTargetPlatform:
{
Required: False ,
}
string ,
featureId:
{
Required: False ,
}
string ,
issueCategory:
{
Required: False ,
}
string ,
moreInformation:
{
Required: False ,
}
string ,
}
,
]
,
targetReadiness:
{
Description: The target readiness for migration for this database. ,
Required: False ,
}
{
azureSqlDatabase:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlManagedInstance:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlVirtualMachine:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerDatabases_List (new)
Description :  List the databases associated with the given Arc Sql Server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/databases
{
subscriptionId:
{
Description: The ID of the Azure subscription ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Azure resource group ,
Required: True ,
}
string ,
sqlServerInstanceName:
{
Description: Name of SQL Server Instance ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of Arc Sql Server database. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of Arc Sql Server database ,
Required: True ,
}
{
collationName:
{
Description: Collation of the database. ,
Required: False ,
}
string ,
databaseCreationDate:
{
Description: Creation date of the database. ,
Format: date-time ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: Compatibility level of the database ,
Format: int32 ,
Required: False ,
}
integer ,
sizeMB:
{
Description: Size of the database. ,
Format: float ,
Required: False ,
}
number ,
logFileSizeMB:
{
Description: Total size in MB for the log (ldf) files for this database. ,
Format: float ,
Required: False ,
}
number ,
dataFileSizeMB:
{
Description: Total size in MB for the data (mdf and ndf) files for this database. ,
Format: float ,
Required: False ,
}
number ,
spaceAvailableMB:
{
Description: Space left of the database. ,
Format: float ,
Required: False ,
}
number ,
state:
{
Description: State of the database. ,
Enum:
{
Online: No description available. ,
Restoring: No description available. ,
Recovering: No description available. ,
RecoveryPending: No description available. ,
Suspect: No description available. ,
Emergency: No description available. ,
Offline: No description available. ,
Copying: No description available. ,
OfflineSecondary: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: Whether the database is read only or not. ,
Required: False ,
}
boolean ,
recoveryMode:
{
Description: Status of the database. ,
Enum:
{
Full: No description available. ,
Bulk-logged: No description available. ,
Simple: No description available. ,
}
,
Required: False ,
}
enum ,
databaseOptions:
{
Description: List of features that are enabled for the database ,
Required: False ,
}
{
isAutoCloseOn:
{
Required: False ,
}
boolean ,
isAutoShrinkOn:
{
Required: False ,
}
boolean ,
isAutoCreateStatsOn:
{
Required: False ,
}
boolean ,
isAutoUpdateStatsOn:
{
Required: False ,
}
boolean ,
isRemoteDataArchiveEnabled:
{
Required: False ,
}
boolean ,
isMemoryOptimizationEnabled:
{
Required: False ,
}
boolean ,
isEncrypted:
{
Required: False ,
}
boolean ,
isTrustworthyOn:
{
Required: False ,
}
boolean ,
isHekatonFilesOn:
{
Description: Whether the database uses the In-Memory OLTP feature for storing in-memory objects. ,
Required: False ,
}
boolean ,
numberOfHekatonFiles:
{
Description: How many Hekaton files the DB has on disk, if it uses in-memory OLTP objects. ,
Format: int32 ,
Required: False ,
}
number ,
}
,
backupInformation:
{
Required: False ,
}
{
lastFullBackup:
{
Description: Date time of last full backup. ,
Format: date-time ,
Required: False ,
}
string ,
lastLogBackup:
{
Description: Date time of last log backup. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
backupPolicy:
{
Description: The backup profile for the SQL server. ,
Required: False ,
}
{
retentionPeriodDays:
{
Description: The retention period for all the databases in this managed instance. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupDays:
{
Description: The value indicating days between full backups. ,
Format: int32 ,
Required: False ,
}
integer ,
differentialBackupHours:
{
Description: The differential backup interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionLogBackupMinutes:
{
Description: The value indicating minutes between transaction log backups. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
earliestRestoreDate:
{
Description: This records the earliest start date and time that restore is available for this database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
createMode:
{
Description: Database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. sourceDatabaseId and restorePointInTime must be specified. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
}
,
Required: False ,
}
enum ,
sourceDatabaseId:
{
Description: The name of the source database associated with create operation of this database. ,
Required: False ,
}
string ,
vmId:
{
Description: The unique ID of the hybrid machine that this resource belongs to. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the Arc-enabled SQL Server database resource. ,
Required: False ,
}
string ,
lastDatabaseUploadTime:
{
Description: The time when last successful database upload was performed. ,
Format: date-time ,
Required: False ,
}
string ,
migration:
{
Description: Migration related configuration. ,
Required: False ,
}
{
assessment:
{
Description: Migration assessments related configuration. ,
Required: False ,
}
{
assessmentUploadTime:
{
Description: The time when Migration Assessment Report upload was last performed. ,
Format: date-time ,
Required: False ,
}
string ,
databaseAssessments:
{
Description: Issues and warnings impacting the migration of Database to particular Azure Migration Target. ,
Required: False ,
}
[
{
appliesToMigrationTargetPlatform:
{
Required: False ,
}
string ,
featureId:
{
Required: False ,
}
string ,
issueCategory:
{
Required: False ,
}
string ,
moreInformation:
{
Required: False ,
}
string ,
}
,
]
,
targetReadiness:
{
Description: The target readiness for migration for this database. ,
Required: False ,
}
{
azureSqlDatabase:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlManagedInstance:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
azureSqlVirtualMachine:
{
Description: The SKU recommendation summary. ,
Required: False ,
}
{
numOfBlockerIssues:
{
Description: Number of blocker issues to fix before migrating this database to the target platform. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendationStatus:
{
Description: The target recommendation Status for this database. ,
Enum:
{
NotReady: No description available. ,
Ready: No description available. ,
ReadyWithConditions: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
impactedObjectsSummary:
{
Required: False ,
}
[
{
featureId:
{
Description: Represents the feature id from https://learn.microsoft.com/en-us/data-migration/sql-server/database/assessment-rules?view=azuresql. OR https://learn.microsoft.com/en-us/data-migration/sql-server/managed-instance/assessment-rules?view=azuresql ,
Required: False ,
}
string ,
numberImpacted:
{
Description: Represents the number of issues/warnings. ,
Format: int32 ,
Required: False ,
}
number ,
issueCategory:
{
Description: Issue or Warning ,
Required: False ,
}
string ,
}
,
]
,
monthlyCost:
{
Description: The monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
sqlLicenseCost:
{
Description: Represents the Cost of SQL license. ,
Format: float ,
Required: False ,
}
number ,
windowsLicenseCost:
{
Description: Represents the Cost of Windows license. ,
Format: float ,
Required: False ,
}
number ,
totalCost:
{
Description: Represents the Total Cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
monthlyCostOptions:
{
Description: The monthly cost for all different savings options applicable for the particular SKU. ,
Required: False ,
}
[
{
keyName:
{
Description: The unique combination of saving options for a price e.g. With1YearASPAndProd. ,
Required: False ,
}
string ,
keyValue:
{
Description: The Monthly cost of the particular SKU. ,
Required: False ,
}
{
computeCost:
{
Description: Represents the Cost of Compute. ,
Format: float ,
Required: False ,
}
number ,
storageCost:
{
Description: Represents the Cost of Storage. ,
Format: float ,
Required: False ,
}
number ,
iopsCost:
{
Description: Represents the Cost of IOPS. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
]
,
targetSku:
{
Required: False ,
}
{
category:
{
Required: False ,
}
{
computeTier:
{
Description: The compute tier of the target SKU. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the target SKU. ,
Required: False ,
}
string ,
sqlPurchasingModel:
{
Description: The SQL purchasing model of the target SKU. ,
Required: False ,
}
string ,
sqlServiceTier:
{
Description: The SQL service tier of the target SKU. ,
Required: False ,
}
string ,
zoneRedundancyAvailable:
{
Description: Indicates if zone redundancy is available for the target SKU. ,
Required: False ,
}
boolean ,
}
,
computeSize:
{
Description: Compute Size in vCores. ,
Format: int32 ,
Required: False ,
}
number ,
storageMaxSizeInMb:
{
Description: max storage for this particular SKU, in MB. ,
Format: float ,
Required: False ,
}
number ,
predictedDataSizeInMb:
{
Description: The predicted data size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
predictedLogSizeInMb:
{
Description: The predicted log size in MB in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxStorageIops:
{
Description: The max storage IOPS in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
maxThroughputMBps:
{
Description: The max throughput in Azure SQL, will impact the billing cost. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
}
,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerEsuLicenses_List (new)
Description :  List sqlServerEsuLicense resources in the subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlServerEsuLicenses
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: SQL Server ESU license properties ,
Required: True ,
}
{
billingPlan:
{
Description: SQL Server ESU license type. ,
Enum:
{
PAYG: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: The SQL Server version the license covers. ,
Enum:
{
SQL Server 2012: No description available. ,
SQL Server 2014: No description available. ,
}
,
Required: True ,
}
enum ,
uniqueId:
{
Description: The unique ID of this license. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: False ,
}
string ,
physicalCores:
{
Description: The number of total cores of the license covers. ,
Format: int32 ,
Required: True ,
}
integer ,
activationState:
{
Description: The activation state of the license. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
Terminated: No description available. ,
}
,
Required: True ,
}
enum ,
scopeType:
{
Description: The Azure scope to which the license will apply. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
ResourceGroup: No description available. ,
}
,
Required: True ,
}
enum ,
activatedAt:
{
Description: The timestamp of the activation of the SqlServerEsuLicense in ISO 8601 date-time format. ,
Format: date-time ,
Required: False ,
}
string ,
terminatedAt:
{
Description: The timestamp of the termination of the SqlServerEsuLicense in ISO 8601 date-time format. ,
Format: date-time ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId the SQL Server ESU license resource subscription resides in. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerEsuLicenses_ListByResourceGroup (new)
Description :  Gets all sqlServerEsuLicenses in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerEsuLicenses
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: SQL Server ESU license properties ,
Required: True ,
}
{
billingPlan:
{
Description: SQL Server ESU license type. ,
Enum:
{
PAYG: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: The SQL Server version the license covers. ,
Enum:
{
SQL Server 2012: No description available. ,
SQL Server 2014: No description available. ,
}
,
Required: True ,
}
enum ,
uniqueId:
{
Description: The unique ID of this license. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: False ,
}
string ,
physicalCores:
{
Description: The number of total cores of the license covers. ,
Format: int32 ,
Required: True ,
}
integer ,
activationState:
{
Description: The activation state of the license. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
Terminated: No description available. ,
}
,
Required: True ,
}
enum ,
scopeType:
{
Description: The Azure scope to which the license will apply. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
ResourceGroup: No description available. ,
}
,
Required: True ,
}
enum ,
activatedAt:
{
Description: The timestamp of the activation of the SqlServerEsuLicense in ISO 8601 date-time format. ,
Format: date-time ,
Required: False ,
}
string ,
terminatedAt:
{
Description: The timestamp of the termination of the SqlServerEsuLicense in ISO 8601 date-time format. ,
Format: date-time ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId the SQL Server ESU license resource subscription resides in. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerEsuLicenses_Get (new)
Description :  Retrieves a SQL Server ESU license resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/{sqlServerEsuLicenseName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlServerEsuLicenseName:
{
Description: Name of SQL Server ESU License ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SQL Server ESU license properties ,
Required: True ,
}
{
billingPlan:
{
Description: SQL Server ESU license type. ,
Enum:
{
PAYG: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: The SQL Server version the license covers. ,
Enum:
{
SQL Server 2012: No description available. ,
SQL Server 2014: No description available. ,
}
,
Required: True ,
}
enum ,
uniqueId:
{
Description: The unique ID of this license. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: False ,
}
string ,
physicalCores:
{
Description: The number of total cores of the license covers. ,
Format: int32 ,
Required: True ,
}
integer ,
activationState:
{
Description: The activation state of the license. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
Terminated: No description available. ,
}
,
Required: True ,
}
enum ,
scopeType:
{
Description: The Azure scope to which the license will apply. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
ResourceGroup: No description available. ,
}
,
Required: True ,
}
enum ,
activatedAt:
{
Description: The timestamp of the activation of the SqlServerEsuLicense in ISO 8601 date-time format. ,
Format: date-time ,
Required: False ,
}
string ,
terminatedAt:
{
Description: The timestamp of the termination of the SqlServerEsuLicense in ISO 8601 date-time format. ,
Format: date-time ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId the SQL Server ESU license resource subscription resides in. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerEsuLicenses_Create (new)
Description :  Creates or replaces a SQL Server ESU license resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/{sqlServerEsuLicenseName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlServerEsuLicenseName:
{
Description: Name of SQL Server ESU License ,
Required: True ,
}
string ,
sqlServerEsuLicense:
{
Description: The SQL Server ESU license to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: SQL Server ESU license properties ,
Required: True ,
}
{
billingPlan:
{
Description: SQL Server ESU license type. ,
Enum:
{
PAYG: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: The SQL Server version the license covers. ,
Enum:
{
SQL Server 2012: No description available. ,
SQL Server 2014: No description available. ,
}
,
Required: True ,
}
enum ,
uniqueId:
{
Description: The unique ID of this license. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: False ,
}
string ,
physicalCores:
{
Description: The number of total cores of the license covers. ,
Format: int32 ,
Required: True ,
}
integer ,
activationState:
{
Description: The activation state of the license. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
Terminated: No description available. ,
}
,
Required: True ,
}
enum ,
scopeType:
{
Description: The Azure scope to which the license will apply. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
ResourceGroup: No description available. ,
}
,
Required: True ,
}
enum ,
activatedAt:
{
Description: The timestamp of the activation of the SqlServerEsuLicense in ISO 8601 date-time format. ,
Format: date-time ,
Required: False ,
}
string ,
terminatedAt:
{
Description: The timestamp of the termination of the SqlServerEsuLicense in ISO 8601 date-time format. ,
Format: date-time ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId the SQL Server ESU license resource subscription resides in. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SQL Server ESU license properties ,
Required: True ,
}
{
billingPlan:
{
Description: SQL Server ESU license type. ,
Enum:
{
PAYG: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: The SQL Server version the license covers. ,
Enum:
{
SQL Server 2012: No description available. ,
SQL Server 2014: No description available. ,
}
,
Required: True ,
}
enum ,
uniqueId:
{
Description: The unique ID of this license. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: False ,
}
string ,
physicalCores:
{
Description: The number of total cores of the license covers. ,
Format: int32 ,
Required: True ,
}
integer ,
activationState:
{
Description: The activation state of the license. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
Terminated: No description available. ,
}
,
Required: True ,
}
enum ,
scopeType:
{
Description: The Azure scope to which the license will apply. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
ResourceGroup: No description available. ,
}
,
Required: True ,
}
enum ,
activatedAt:
{
Description: The timestamp of the activation of the SqlServerEsuLicense in ISO 8601 date-time format. ,
Format: date-time ,
Required: False ,
}
string ,
terminatedAt:
{
Description: The timestamp of the termination of the SqlServerEsuLicense in ISO 8601 date-time format. ,
Format: date-time ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId the SQL Server ESU license resource subscription resides in. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: SQL Server ESU license properties ,
Required: True ,
}
{
billingPlan:
{
Description: SQL Server ESU license type. ,
Enum:
{
PAYG: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: The SQL Server version the license covers. ,
Enum:
{
SQL Server 2012: No description available. ,
SQL Server 2014: No description available. ,
}
,
Required: True ,
}
enum ,
uniqueId:
{
Description: The unique ID of this license. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: False ,
}
string ,
physicalCores:
{
Description: The number of total cores of the license covers. ,
Format: int32 ,
Required: True ,
}
integer ,
activationState:
{
Description: The activation state of the license. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
Terminated: No description available. ,
}
,
Required: True ,
}
enum ,
scopeType:
{
Description: The Azure scope to which the license will apply. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
ResourceGroup: No description available. ,
}
,
Required: True ,
}
enum ,
activatedAt:
{
Description: The timestamp of the activation of the SqlServerEsuLicense in ISO 8601 date-time format. ,
Format: date-time ,
Required: False ,
}
string ,
terminatedAt:
{
Description: The timestamp of the termination of the SqlServerEsuLicense in ISO 8601 date-time format. ,
Format: date-time ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId the SQL Server ESU license resource subscription resides in. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlServerEsuLicenses_Delete (new)
Description :  Deletes a SQL Server ESU license resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/{sqlServerEsuLicenseName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlServerEsuLicenseName:
{
Description: Name of SQL Server ESU License ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (204)

{}
SqlServerEsuLicenses_Update (new)
Description :  Updates a SQL Server ESU license resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/{sqlServerEsuLicenseName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlServerEsuLicenseName:
{
Description: Name of SQL Server ESU License ,
Required: True ,
}
string ,
parameters:
{
Description: The SQL Server ESU license. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: null ,
Required: False ,
}
{
billingPlan:
{
Description: SQL Server ESU license type. ,
Enum:
{
PAYG: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The SQL Server version the license covers. ,
Enum:
{
SQL Server 2012: No description available. ,
SQL Server 2014: No description available. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: The unique ID of this license. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: False ,
}
string ,
physicalCores:
{
Description: The number of total cores of the license covers. ,
Format: int32 ,
Required: False ,
}
integer ,
activationState:
{
Description: The activation state of the license. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
Terminated: No description available. ,
}
,
Required: False ,
}
enum ,
scopeType:
{
Description: The Azure scope to which the license will apply. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
ResourceGroup: No description available. ,
}
,
Required: False ,
}
enum ,
activatedAt:
{
Description: The timestamp of the activation of the SqlServerEsuLicense in ISO 8601 date-time format. ,
Format: date-time ,
Required: False ,
}
string ,
terminatedAt:
{
Description: The timestamp of the termination of the SqlServerEsuLicense in ISO 8601 date-time format. ,
Format: date-time ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId the SQL Server ESU license resource subscription resides in. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SQL Server ESU license properties ,
Required: True ,
}
{
billingPlan:
{
Description: SQL Server ESU license type. ,
Enum:
{
PAYG: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: The SQL Server version the license covers. ,
Enum:
{
SQL Server 2012: No description available. ,
SQL Server 2014: No description available. ,
}
,
Required: True ,
}
enum ,
uniqueId:
{
Description: The unique ID of this license. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: False ,
}
string ,
physicalCores:
{
Description: The number of total cores of the license covers. ,
Format: int32 ,
Required: True ,
}
integer ,
activationState:
{
Description: The activation state of the license. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
Terminated: No description available. ,
}
,
Required: True ,
}
enum ,
scopeType:
{
Description: The Azure scope to which the license will apply. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
ResourceGroup: No description available. ,
}
,
Required: True ,
}
enum ,
activatedAt:
{
Description: The timestamp of the activation of the SqlServerEsuLicense in ISO 8601 date-time format. ,
Format: date-time ,
Required: False ,
}
string ,
terminatedAt:
{
Description: The timestamp of the termination of the SqlServerEsuLicense in ISO 8601 date-time format. ,
Format: date-time ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId the SQL Server ESU license resource subscription resides in. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}