Databases - Get

Serviço:

SQL Database

Versão da API:

2023-08-01

Obtém um banco de dados.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}?api-version=2023-08-01

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}?$expand={$expand}&$filter={$filter}&api-version=2023-08-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
databaseName	path	True	string	O nome do banco de dados.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	A ID de assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.
$expand	query		string	Os recursos da criança para incluir na resposta.
$filter	query		string	Uma expressão de filtro OData que filtra elementos na coleção.

Respostas

Name	Tipo	Description
200 OK	Database	Recuperado com êxito o banco de dados especificado.
Other Status Codes	ErrorResponse	Respostas de erro: *** 400 ManagedInstanceStoppingOrStopped - Operação conflitante enviada enquanto a instância está no estado de parada/parada 400 ManagedInstanceStarting - Operação conflitante enviada enquanto a instância está no estado inicial 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na assinatura especificados. 404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado 404 ResourceNotFound - O recurso solicitado não foi encontrado.

Exemplos

Gets a database configured with Default enclave type.

Gets a database configured with VBS enclave type.

Gets a database with Availability zone specified.

Gets a database with database level keys expanded.

Gets a database.

Gets a database configured with Default enclave type.

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?api-version=2023-08-01

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/GetVCoreDatabaseDefaultEnclave.json
// this example is just showing the usage of "Databases_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string serverName = "testsvr";
string databaseName = "testdb";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// invoke the operation
SqlDatabaseResource result = await sqlDatabase.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlDatabaseData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:

200

{
  "sku": {
    "name": "BC_Gen5",
    "tier": "BusinessCritical",
    "capacity": 2
  },
  "kind": "v12.0,user,vcore",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 268435456000,
    "status": "Online",
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentServiceObjectiveName": "BC_Gen5_2",
    "requestedServiceObjectiveName": "BC_Gen5_2",
    "defaultSecondaryLocation": "North Europe",
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "licenseType": "LicenseIncluded",
    "maxLogSizeBytes": 104857600,
    "isInfraEncryptionEnabled": false,
    "zoneRedundant": false,
    "readScale": "Enabled",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1",
    "currentSku": {
      "name": "BC_Gen5",
      "tier": "BusinessCritical",
      "capacity": 2
    },
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "isLedgerOn": false,
    "preferredEnclaveType": "Default"
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases"
}

Gets a database configured with VBS enclave type.

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?api-version=2023-08-01

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/GetVCoreDatabaseVBSEnclave.json
// this example is just showing the usage of "Databases_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string serverName = "testsvr";
string databaseName = "testdb";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// invoke the operation
SqlDatabaseResource result = await sqlDatabase.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlDatabaseData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:

200

{
  "sku": {
    "name": "BC_Gen5",
    "tier": "BusinessCritical",
    "capacity": 2
  },
  "kind": "v12.0,user,vcore",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 268435456000,
    "status": "Online",
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentServiceObjectiveName": "BC_Gen5_2",
    "requestedServiceObjectiveName": "BC_Gen5_2",
    "defaultSecondaryLocation": "North Europe",
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "licenseType": "LicenseIncluded",
    "maxLogSizeBytes": 104857600,
    "isInfraEncryptionEnabled": false,
    "zoneRedundant": false,
    "readScale": "Enabled",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1",
    "currentSku": {
      "name": "BC_Gen5",
      "tier": "BusinessCritical",
      "capacity": 2
    },
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "isLedgerOn": false,
    "preferredEnclaveType": "VBS"
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases"
}

Gets a database with Availability zone specified.

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?api-version=2023-08-01

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/GetDatabaseWithAvailabilityZone.json
// this example is just showing the usage of "Databases_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string serverName = "testsvr";
string databaseName = "testdb";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// invoke the operation
SqlDatabaseResource result = await sqlDatabase.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlDatabaseData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:

200

{
  "sku": {
    "name": "S0",
    "tier": "Standard",
    "capacity": 10
  },
  "kind": "v12.0,user",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 1073741824,
    "status": "Online",
    "currentSku": {
      "name": "Standard",
      "tier": "Standard",
      "capacity": 10
    },
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentBackupStorageRedundancy": "Geo",
    "currentServiceObjectiveName": "S0",
    "defaultSecondaryLocation": "North Europe",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "readScale": "Disabled",
    "requestedBackupStorageRedundancy": "Geo",
    "requestedServiceObjectiveName": "S0",
    "isInfraEncryptionEnabled": false,
    "zoneRedundant": false,
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "isLedgerOn": false,
    "availabilityZone": "1"
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases"
}

Gets a database with database level keys expanded.

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?$expand=keys&api-version=2023-08-01

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/GetVCoreDatabaseWithExpandEqualsKeys.json
// this example is just showing the usage of "Databases_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string serverName = "testsvr";
string databaseName = "testdb";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// invoke the operation
string expand = "keys";
SqlDatabaseResource result = await sqlDatabase.GetAsync(expand: expand);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlDatabaseData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:

200

{
  "sku": {
    "name": "BC_Gen5",
    "tier": "BusinessCritical",
    "capacity": 2
  },
  "kind": "v12.0,user,vcore",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 268435456000,
    "status": "Online",
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentServiceObjectiveName": "BC_Gen5_2",
    "requestedServiceObjectiveName": "BC_Gen5_2",
    "defaultSecondaryLocation": "North Europe",
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "licenseType": "LicenseIncluded",
    "maxLogSizeBytes": 104857600,
    "isInfraEncryptionEnabled": false,
    "zoneRedundant": false,
    "readScale": "Enabled",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1",
    "currentSku": {
      "name": "BC_Gen5",
      "tier": "BusinessCritical",
      "capacity": 2
    },
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "isLedgerOn": false,
    "keys": {
      "https://your-key-vault-name.vault.azure.net/yourKey/yourKeyVersion": {},
      "https://your-key-vault-name.vault.azure.net/yourKey2/yourKey2Version": {}
    },
    "encryptionProtector": "https://your-key-vault-name.vault.azure.net/yourKey/yourKeyVersion"
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases"
}

Gets a database.

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?api-version=2023-08-01

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/GetVCoreDatabase.json
// this example is just showing the usage of "Databases_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string serverName = "testsvr";
string databaseName = "testdb";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// invoke the operation
SqlDatabaseResource result = await sqlDatabase.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlDatabaseData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:

200

{
  "sku": {
    "name": "BC_Gen5",
    "tier": "BusinessCritical",
    "capacity": 2
  },
  "kind": "v12.0,user,vcore",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 268435456000,
    "status": "Online",
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentServiceObjectiveName": "BC_Gen5_2",
    "requestedServiceObjectiveName": "BC_Gen5_2",
    "defaultSecondaryLocation": "North Europe",
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "licenseType": "LicenseIncluded",
    "maxLogSizeBytes": 104857600,
    "isInfraEncryptionEnabled": false,
    "zoneRedundant": false,
    "readScale": "Enabled",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1",
    "currentSku": {
      "name": "BC_Gen5",
      "tier": "BusinessCritical",
      "capacity": 2
    },
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "isLedgerOn": false
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases"
}

Definições

Name	Description
AlwaysEncryptedEnclaveType	Tipo de enclave solicitado no banco de dados, ou seja, enclaves padrão ou VBS.
AvailabilityZoneType	Especifica a zona de disponibilidade na qual o banco de dados está fixado.
BackupStorageRedundancy	O tipo de conta de armazenamento usado para armazenar backups para esse banco de dados.
CatalogCollationType	Agrupamento do catálogo de metadados.
CreateMode	Especifica o modo de criação do banco de dados. Padrão: criação regular de banco de dados. Copiar: cria um banco de dados como uma cópia de um banco de dados existente. sourceDatabaseId deve ser especificado como a ID do recurso do banco de dados de origem. Secundário: cria um banco de dados como uma réplica secundária de um banco de dados existente. sourceDatabaseId deve ser especificado como a ID do recurso do banco de dados primário existente. PointInTimeRestore: Cria um banco de dados restaurando um backup point-in-time de um banco de dados existente. sourceDatabaseId deve ser especificado como a ID de recurso do banco de dados existente e restorePointInTime deve ser especificado. Recuperação: cria um banco de dados restaurando um backup replicado geograficamente. sourceDatabaseId deve ser especificado como o ID de recurso de banco de dados recuperável a ser restaurado. Restaurar: cria um banco de dados restaurando um backup de um banco de dados excluído. sourceDatabaseId deve ser especificado. Se sourceDatabaseId for o ID de recurso original do banco de dados, sourceDatabaseDeletionDate deverá ser especificado. Caso contrário, sourceDatabaseId deve ser o ID de recurso de banco de dados descartado restaurável e sourceDatabaseDeletionDate é ignorado. restorePointInTime também pode ser especificado para restaurar a partir de um point-in-time anterior. RestoreLongTermRetentionBackup: cria um banco de dados restaurando a partir de um cofre de retenção de longo prazo. recoveryServicesRecoveryPointResourceId deve ser especificado como o ID do recurso do ponto de recuperação. Copy, Secondary e RestoreLongTermRetentionBackup não são suportados para a edição DataWarehouse.
Database	Um recurso de banco de dados.
DatabaseIdentity	Configuração de identidade do Azure Ative Directory para um recurso.
DatabaseIdentityType	O tipo de identidade
DatabaseKey	Chave de nível de banco de dados usada para criptografia em repouso.
DatabaseKeyType	O tipo de chave do banco de dados. Apenas o valor suportado é 'AzureKeyVault'.
DatabaseLicenseType	O tipo de licença a ser aplicado para este banco de dados. LicenseIncluded se precisar de uma licença ou BasePrice se tiver uma licença e estiver qualificado para o Benefício Híbrido do Azure.
DatabaseReadScale	O estado do roteamento somente leitura. Se habilitadas, as conexões que têm a intenção do aplicativo definida como somente leitura em sua cadeia de conexão podem ser roteadas para uma réplica secundária somente leitura na mesma região. Não aplicável a um banco de dados Hyperscale dentro de um pool elástico.
DatabaseStatus	O status do banco de dados.
DatabaseUserIdentity	Configuração de identidade do Azure Ative Directory para um recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
FreeLimitExhaustionBehavior	Especifica o comportamento quando os limites livres mensais são esgotados para o banco de dados livre. AutoPause: O banco de dados será pausado automaticamente após o esgotamento dos limites livres pelo restante do mês. BillForUsage: O banco de dados continuará on-line após o esgotamento dos limites gratuitos e qualquer excesso de idade será cobrado.
SampleName	O nome do esquema de exemplo a ser aplicado ao criar esse banco de dados.
SecondaryType	O tipo secundário do banco de dados, se for secundário. Os valores válidos são Geo, Named e Standby.
Sku	Um SKU de recurso ARM.

AlwaysEncryptedEnclaveType

Enumeração

Tipo de enclave solicitado no banco de dados, ou seja, enclaves padrão ou VBS.

Valor	Description
Default
VBS

AvailabilityZoneType

Enumeração

Especifica a zona de disponibilidade na qual o banco de dados está fixado.

Valor	Description
NoPreference
1
2
3

BackupStorageRedundancy

Enumeração

O tipo de conta de armazenamento usado para armazenar backups para esse banco de dados.

Valor	Description
Geo
Local
Zone
GeoZone

CatalogCollationType

Enumeração

Agrupamento do catálogo de metadados.

Valor	Description
DATABASE_DEFAULT
SQL_Latin1_General_CP1_CI_AS

CreateMode

Enumeração

Especifica o modo de criação do banco de dados.

Padrão: criação regular de banco de dados.

Copiar: cria um banco de dados como uma cópia de um banco de dados existente. sourceDatabaseId deve ser especificado como a ID do recurso do banco de dados de origem.

Secundário: cria um banco de dados como uma réplica secundária de um banco de dados existente. sourceDatabaseId deve ser especificado como a ID do recurso do banco de dados primário existente.

PointInTimeRestore: Cria um banco de dados restaurando um backup point-in-time de um banco de dados existente. sourceDatabaseId deve ser especificado como a ID de recurso do banco de dados existente e restorePointInTime deve ser especificado.

Recuperação: cria um banco de dados restaurando um backup replicado geograficamente. sourceDatabaseId deve ser especificado como o ID de recurso de banco de dados recuperável a ser restaurado.

Restaurar: cria um banco de dados restaurando um backup de um banco de dados excluído. sourceDatabaseId deve ser especificado. Se sourceDatabaseId for o ID de recurso original do banco de dados, sourceDatabaseDeletionDate deverá ser especificado. Caso contrário, sourceDatabaseId deve ser o ID de recurso de banco de dados descartado restaurável e sourceDatabaseDeletionDate é ignorado. restorePointInTime também pode ser especificado para restaurar a partir de um point-in-time anterior.

RestoreLongTermRetentionBackup: cria um banco de dados restaurando a partir de um cofre de retenção de longo prazo. recoveryServicesRecoveryPointResourceId deve ser especificado como o ID do recurso do ponto de recuperação.

Copy, Secondary e RestoreLongTermRetentionBackup não são suportados para a edição DataWarehouse.

Valor	Description
Default
Copy
Secondary
PointInTimeRestore
Restore
Recovery
RestoreExternalBackup
RestoreExternalBackupSecondary
RestoreLongTermRetentionBackup
OnlineSecondary

Database

Object

Um recurso de banco de dados.

Name	Tipo	Description
id	string	ID do recurso.
identity	DatabaseIdentity	A identidade do Azure Ative Directory do banco de dados.
kind	string	Tipo de base de dados. Esses são metadados usados para a experiência do portal do Azure.
location	string	Localização do recurso.
managedBy	string	Recurso que gerencia o banco de dados.
name	string	Nome do recurso.
properties.autoPauseDelay	integer (int32)	Tempo em minutos após o qual o banco de dados é pausado automaticamente. Um valor de -1 significa que a pausa automática está desativada
properties.availabilityZone	AvailabilityZoneType	Especifica a zona de disponibilidade na qual o banco de dados está fixado.
properties.catalogCollation	CatalogCollationType	Agrupamento do catálogo de metadados.
properties.collation	string	O agrupamento do banco de dados.
properties.createMode	CreateMode	Especifica o modo de criação do banco de dados. Padrão: criação regular de banco de dados. Copiar: cria um banco de dados como uma cópia de um banco de dados existente. sourceDatabaseId deve ser especificado como a ID do recurso do banco de dados de origem. Secundário: cria um banco de dados como uma réplica secundária de um banco de dados existente. sourceDatabaseId deve ser especificado como a ID do recurso do banco de dados primário existente. PointInTimeRestore: Cria um banco de dados restaurando um backup point-in-time de um banco de dados existente. sourceDatabaseId deve ser especificado como a ID de recurso do banco de dados existente e restorePointInTime deve ser especificado. Recuperação: cria um banco de dados restaurando um backup replicado geograficamente. sourceDatabaseId deve ser especificado como o ID de recurso de banco de dados recuperável a ser restaurado. Restaurar: cria um banco de dados restaurando um backup de um banco de dados excluído. sourceDatabaseId deve ser especificado. Se sourceDatabaseId for o ID de recurso original do banco de dados, sourceDatabaseDeletionDate deverá ser especificado. Caso contrário, sourceDatabaseId deve ser o ID de recurso de banco de dados descartado restaurável e sourceDatabaseDeletionDate é ignorado. restorePointInTime também pode ser especificado para restaurar a partir de um point-in-time anterior. RestoreLongTermRetentionBackup: cria um banco de dados restaurando a partir de um cofre de retenção de longo prazo. recoveryServicesRecoveryPointResourceId deve ser especificado como o ID do recurso do ponto de recuperação. Copy, Secondary e RestoreLongTermRetentionBackup não são suportados para a edição DataWarehouse.
properties.creationDate	string (date-time)	A data de criação da base de dados (formato ISO8601).
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	O tipo de conta de armazenamento usado para armazenar backups para esse banco de dados.
properties.currentServiceObjectiveName	string	O nome atual do objetivo de nível de serviço do banco de dados.
properties.currentSku	Sku	O nome e a camada da SKU.
properties.databaseId	string (uuid)	A ID do banco de dados.
properties.defaultSecondaryLocation	string	A região secundária padrão para esse banco de dados.
properties.earliestRestoreDate	string (date-time)	Isso registra a data e a hora de início mais antigas em que a restauração está disponível para esse banco de dados (formato ISO8601).
properties.elasticPoolId	string (arm-id)	O identificador de recurso do pool elástico que contém esse banco de dados.
properties.encryptionProtector	string	O URI do cofre de chaves azure do banco de dados se estiver configurado com chaves gerenciadas pelo cliente do banco de dados.
properties.encryptionProtectorAutoRotation	boolean	O sinalizador para ativar ou desativar a rotação automática da chave AKV do protetor de criptografia do banco de dados.
properties.failoverGroupId	string	Identificador de recurso do Grupo de Failover ao qual esse banco de dados pertence.
properties.federatedClientId	string (uuid)	A ID do cliente usada para o cenário de CMK entre locatários por banco de dados
properties.freeLimitExhaustionBehavior	FreeLimitExhaustionBehavior	Especifica o comportamento quando os limites livres mensais são esgotados para o banco de dados livre. AutoPause: O banco de dados será pausado automaticamente após o esgotamento dos limites livres pelo restante do mês. BillForUsage: O banco de dados continuará on-line após o esgotamento dos limites gratuitos e qualquer excesso de idade será cobrado.
properties.highAvailabilityReplicaCount	integer (int32)	O número de réplicas secundárias associadas ao banco de dados Business Critical, Premium ou Hyperscale edition que são usadas para fornecer alta disponibilidade. Não aplicável a um banco de dados Hyperscale dentro de um pool elástico.
properties.isInfraEncryptionEnabled	boolean	A criptografia de infra está habilitada para esse banco de dados.
properties.isLedgerOn	boolean	Se esse banco de dados é ou não um banco de dados contábil, o que significa que todas as tabelas no banco de dados são tabelas contábeis. Nota: o valor desta propriedade não pode ser alterado após a criação do banco de dados.
properties.keys	<string,  DatabaseKey>	As ids de recurso das identidades atribuídas ao usuário a serem usadas
properties.licenseType	DatabaseLicenseType	O tipo de licença a ser aplicado para este banco de dados. LicenseIncluded se precisar de uma licença ou BasePrice se tiver uma licença e estiver qualificado para o Benefício Híbrido do Azure.
properties.longTermRetentionBackupResourceId	string (arm-id)	O identificador de recurso do backup de retenção de longo prazo associado à operação de criação desse banco de dados.
properties.maintenanceConfigurationId	string	ID de configuração de manutenção atribuído ao banco de dados. Essa configuração define o período em que as atualizações de manutenção ocorrerão.
properties.manualCutover	boolean	Se a substituição manual controlada pelo cliente precisa ou não ser feita durante a operação do Update Database para a camada Hyperscale. Essa propriedade só é aplicável ao dimensionar o banco de dados da camada Business Critical/General Purpose/Premium/Standard para a camada Hyperscale. Quando manualCutover é especificado, a operação de dimensionamento aguardará a entrada do usuário para acionar a substituição para o banco de dados Hyperscale. Para acionar a substituição, forneça o parâmetro 'performCutover' quando a operação Scaling estiver no estado de espera.
properties.maxLogSizeBytes	integer (int64)	O tamanho máximo do log para este banco de dados.
properties.maxSizeBytes	integer (int64)	O tamanho máximo do banco de dados expresso em bytes.
properties.minCapacity	number (double)	Capacidade mínima que o banco de dados sempre terá alocado, se não pausado
properties.pausedDate	string (date-time)	A data em que o banco de dados foi pausado por configuração do usuário ou formato action(ISO8601). Nulo se o banco de dados estiver pronto.
properties.performCutover	boolean	Para acionar a substituição manual controlada pelo cliente durante o estado de espera enquanto a operação de dimensionamento está em andamento. Este parâmetro de propriedade só é aplicável para operações de dimensionamento que são iniciadas junto com o parâmetro 'manualCutover'. Essa propriedade só é aplicável quando o dimensionamento do banco de dados da camada Business Critical/General Purpose/Premium/Standard para a camada Hyperscale já estiver em andamento. Quando performCutover for especificado, a operação de dimensionamento acionará a substituição e executará a alteração de função no banco de dados Hyperscale.
properties.preferredEnclaveType	AlwaysEncryptedEnclaveType	Tipo de enclave solicitado no banco de dados, ou seja, enclaves padrão ou VBS.
properties.readScale	DatabaseReadScale	O estado do roteamento somente leitura. Se habilitadas, as conexões que têm a intenção do aplicativo definida como somente leitura em sua cadeia de conexão podem ser roteadas para uma réplica secundária somente leitura na mesma região. Não aplicável a um banco de dados Hyperscale dentro de um pool elástico.
properties.recoverableDatabaseId	string (arm-id)	O identificador de recurso do banco de dados recuperável associado à operação de criação desse banco de dados.
properties.recoveryServicesRecoveryPointId	string (arm-id)	O identificador de recurso do ponto de recuperação associado à operação de criação desse banco de dados.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	O tipo de conta de armazenamento a ser usado para armazenar backups para esse banco de dados.
properties.requestedServiceObjectiveName	string	O nome do objetivo de nível de serviço solicitado do banco de dados.
properties.restorableDroppedDatabaseId	string (arm-id)	O identificador de recurso do banco de dados descartado restaurável associado à operação de criação desse banco de dados.
properties.restorePointInTime	string (date-time)	Especifica o ponto no tempo (formato ISO8601) do banco de dados de origem que será restaurado para criar o novo banco de dados.
properties.resumedDate	string (date-time)	A data em que o banco de dados foi retomado pela ação do usuário ou login do banco de dados (formato ISO8601). Nulo se o banco de dados estiver pausado.
properties.sampleName	SampleName	O nome do esquema de exemplo a ser aplicado ao criar esse banco de dados.
properties.secondaryType	SecondaryType	O tipo secundário do banco de dados, se for secundário. Os valores válidos são Geo, Named e Standby.
properties.sourceDatabaseDeletionDate	string (date-time)	Especifica a hora em que o banco de dados foi excluído.
properties.sourceDatabaseId	string (arm-id)	O identificador de recurso do banco de dados de origem associado à operação de criação desse banco de dados.
properties.sourceResourceId	string (arm-id)	O identificador de recurso da fonte associada à operação de criação desse banco de dados. Esta propriedade só é suportada para a edição DataWarehouse e permite restaurar entre subscrições. Quando sourceResourceId é especificado, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId e sourceDatabaseDeletionDate não devem ser especificados e CreateMode deve ser PointInTimeRestore, Restore ou Recover. Quando createMode é PointInTimeRestore, sourceResourceId deve ser a ID do recurso do banco de dados existente ou do pool sql existente, e restorePointInTime deve ser especificado. Quando createMode é Restore, sourceResourceId deve ser a ID de recurso do banco de dados descartado restaurável ou do pool sql descartado restaurável. Quando createMode é Recover, sourceResourceId deve ser o ID de recurso do banco de dados recuperável ou do pool sql recuperável. Quando a assinatura de origem pertence a um locatário diferente da assinatura de destino, o cabeçalho "x-ms-authorization-auxiliary" deve conter token de autenticação para o locatário de origem. Para obter mais detalhes sobre o cabeçalho "x-ms-authorization-auxiliary", consulte https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant
properties.status	DatabaseStatus	O status do banco de dados.
properties.useFreeLimit	boolean	Se a base de dados utiliza ou não limites mensais gratuitos. Permitido em um banco de dados em uma assinatura.
properties.zoneRedundant	boolean	Se esse banco de dados é ou não redundante de zona, o que significa que as réplicas desse banco de dados serão espalhadas por várias zonas de disponibilidade.
sku	Sku	O banco de dados SKU. A lista de SKUs pode variar de acordo com a região e a oferta de suporte. Para determinar as SKUs (incluindo o nome, a camada/edição, a família e a capacidade da SKU) que estão disponíveis para sua assinatura em uma região do Azure, use a API REST Capabilities_ListByLocation ou um dos seguintes comandos: az sql db list-editions -l <location> -o table Get-AzSqlServerServiceObjective -Location <location>
tags	object	Tags de recursos.
type	string	Tipo de recurso.

DatabaseIdentity

Object

Configuração de identidade do Azure Ative Directory para um recurso.

Name	Tipo	Description
tenantId	string (uuid)	A ID de locatário do Azure Ative Directory.
type	DatabaseIdentityType	O tipo de identidade
userAssignedIdentities	<string,  DatabaseUserIdentity>	As ids de recurso das identidades atribuídas ao usuário a serem usadas

DatabaseIdentityType

Enumeração

O tipo de identidade

Valor	Description
None
UserAssigned

DatabaseKey

Object

Chave de nível de banco de dados usada para criptografia em repouso.

Name	Tipo	Description
creationDate	string (date-time)	A data de criação da chave do banco de dados.
subregion	string	Sub-região da chave do servidor.
thumbprint	string	Impressão digital da chave do banco de dados.
type	DatabaseKeyType	O tipo de chave do banco de dados. Apenas o valor suportado é 'AzureKeyVault'.

DatabaseKeyType

Enumeração

O tipo de chave do banco de dados. Apenas o valor suportado é 'AzureKeyVault'.

Valor	Description
AzureKeyVault

DatabaseLicenseType

Enumeração

O tipo de licença a ser aplicado para este banco de dados. LicenseIncluded se precisar de uma licença ou BasePrice se tiver uma licença e estiver qualificado para o Benefício Híbrido do Azure.

Valor	Description
LicenseIncluded
BasePrice

DatabaseReadScale

Enumeração

O estado do roteamento somente leitura. Se habilitadas, as conexões que têm a intenção do aplicativo definida como somente leitura em sua cadeia de conexão podem ser roteadas para uma réplica secundária somente leitura na mesma região. Não aplicável a um banco de dados Hyperscale dentro de um pool elástico.

Valor	Description
Enabled
Disabled

DatabaseStatus

Enumeração

O status do banco de dados.

Valor	Description
Online
Restoring
RecoveryPending
Recovering
Suspect
Offline
Standby
Shutdown
EmergencyMode
AutoClosed
Copying
Creating
Inaccessible
OfflineSecondary
Pausing
Paused
Resuming
Scaling
OfflineChangingDwPerformanceTiers
OnlineChangingDwPerformanceTiers
Disabled
Stopping
Stopped
Starting

DatabaseUserIdentity

Object

Configuração de identidade do Azure Ative Directory para um recurso.

Name	Tipo	Description
clientId	string (uuid)	A ID do cliente do Azure Ative Directory.
principalId	string (uuid)	A ID principal do Azure Ative Directory.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

FreeLimitExhaustionBehavior

Enumeração

Especifica o comportamento quando os limites livres mensais são esgotados para o banco de dados livre.

AutoPause: O banco de dados será pausado automaticamente após o esgotamento dos limites livres pelo restante do mês.

BillForUsage: O banco de dados continuará on-line após o esgotamento dos limites gratuitos e qualquer excesso de idade será cobrado.

Valor	Description
AutoPause
BillOverUsage

SampleName

Enumeração

O nome do esquema de exemplo a ser aplicado ao criar esse banco de dados.

Valor	Description
AdventureWorksLT
WideWorldImportersStd
WideWorldImportersFull

SecondaryType

Enumeração

O tipo secundário do banco de dados, se for secundário. Os valores válidos são Geo, Named e Standby.

Valor	Description
Geo
Named
Standby

Sku

Object

Um SKU de recurso ARM.

Name	Tipo	Description
capacity	integer (int32)	Capacidade do SKU específico.
family	string	Se o serviço tiver diferentes gerações de hardware, para o mesmo SKU, isso pode ser capturado aqui.
name	string	O nome do SKU, normalmente, uma letra + código numérico, por exemplo, P3.
size	string	Tamanho do SKU específico
tier	string	O nível ou edição do SKU específico, por exemplo, Basic, Premium.