Managed Database Schemas - List By Database

Servicio:

SQL Database

Versión de la API:

2023-08-01

Enumerar esquemas de base de datos administrados

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
databaseName	path	True	string	Nombre de la base de datos.
managedInstanceName	path	True	string	Nombre de la instancia administrada.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
subscriptionId	path	True	string	Identificador de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	Versión de la API que se va a usar para la solicitud.
$filter	query		string	Expresión de filtro de OData que filtra los elementos de la colección.

Respuestas

Nombre	Tipo	Description
200 OK	DatabaseSchemaListResult	Esquemas de base de datos administrados recuperados correctamente.
Other Status Codes	ErrorResponse	Respuestas de error: *** 400 UpdateNotAllowedOnPausedDatabase: el usuario intentó realizar una actualización en una base de datos en pausa. 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado. 404 DatabaseDoesNotExist: el usuario ha especificado un nombre de base de datos que no existe en esta instancia del servidor. 404 SourceDatabaseNotFound: la base de datos de origen no existe. 404 ResourceDoesNotExist: recurso con el nombre "{0}" no existe. Para continuar, especifique un nombre de recurso válido. 404 InvalidDatabaseSchema: falta el esquema en la base de datos. 404 InvalidDatabaseTable: falta la tabla en la base de datos. 404 InvalidDatabaseColumn: falta columna en la tabla. 503 DatabaseUnavailable: error en la operación porque la base de datos no está disponible.

Ejemplos

List managed database schemas

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas?api-version=2023-08-01

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ManagedDatabaseSchemaListByDatabase.json
// this example is just showing the usage of "ManagedDatabaseSchemas_ListByDatabase" 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 ManagedDatabaseResource created on azure
// for more information of creating ManagedDatabaseResource, please refer to the document of ManagedDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "myRG";
string managedInstanceName = "myManagedInstanceName";
string databaseName = "myDatabase";
ResourceIdentifier managedDatabaseResourceId = ManagedDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName, databaseName);
ManagedDatabaseResource managedDatabase = client.GetManagedDatabaseResource(managedDatabaseResourceId);

// get the collection of this ManagedDatabaseSchemaResource
ManagedDatabaseSchemaCollection collection = managedDatabase.GetManagedDatabaseSchemas();

// invoke the operation and iterate over the result
await foreach (ManagedDatabaseSchemaResource item in collection.GetAllAsync())
{
    // the variable item 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
    DatabaseSchemaData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Respuesta de muestra

status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo",
      "name": "dbo",
      "type": "Microsoft.Sql/managedInstances/databases/schemas"
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/schema2",
      "name": "schema2",
      "type": "Microsoft.Sql/managedInstances/databases/schemas"
    }
  ]
}

Definiciones

Nombre	Description
DatabaseSchema	Un recurso de esquema de base de datos.
DatabaseSchemaListResult	Lista de esquemas de base de datos.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error

DatabaseSchema

Object

Un recurso de esquema de base de datos.

Nombre	Tipo	Description
id	string	Identificador de recurso.
name	string	Nombre del recurso.
type	string	Tipo de recurso.

DatabaseSchemaListResult

Object

Lista de esquemas de base de datos.

Nombre	Tipo	Description
nextLink	string	Vínculo para recuperar la siguiente página de resultados.
value	DatabaseSchema[]	Matriz de resultados.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.