Managed Database Columns - List By Database

Référence

Service:: SQL Database

Version d'API:: 2021-11-01

Répertorier les colonnes de base de données managées

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

Avec des paramètres facultatifs:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/columns?schema={schema}&table={table}&column={column}&orderBy={orderBy}&$skiptoken={$skiptoken}&api-version=2021-11-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
databaseName	path	True	string	Nom de la base de données.
managedInstanceName	path	True	string	Nom de l'instance managée.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.
$skiptoken	query		string	Jeton opaque qui identifie un point de départ dans la collection.
column	query		string[]
orderBy	query		string[]
schema	query		string[]
table	query		string[]

Réponses

Nom	Type	Description
200 OK	DatabaseColumnListResult	Colonnes de base de données récupérées avec succès.
Other Status Codes		Réponses d’erreur : *** 400 UnsupportedColumnOrderByProperty : la propriété order-by '{0}' n’est pas prise en charge. Les propriétés autorisées sont : {1}. 400 UnsupportedColumnSortDirection : la direction de tri de colonne '{0}' n’est pas prise en charge. Valeurs autorisées : {1}. 400 UpdateNotAllowedOnPausedDatabase : l’utilisateur a tenté d’effectuer une mise à jour sur une base de données en pause. 404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable 404 SourceDatabaseNotFound : la base de données source n’existe pas. 404 DatabaseDoesNotExist : l’utilisateur a spécifié un nom de base de données qui n’existe pas sur ce serveur instance. 404 ResourceDoesNotExist : la ressource portant le nom «{0} » n’existe pas. Pour continuer, spécifiez un nom de ressource valide. 503 DatabaseUnavailable : l’opération a échoué car la base de données n’est pas disponible.

Nom

Type

Description

200 OK

DatabaseColumnListResult

Colonnes de base de données récupérées avec succès.

Other Status Codes

Réponses d’erreur : ***

400 UnsupportedColumnOrderByProperty : la propriété order-by '{0}' n’est pas prise en charge. Les propriétés autorisées sont : {1}.
400 UnsupportedColumnSortDirection : la direction de tri de colonne '{0}' n’est pas prise en charge. Valeurs autorisées : {1}.
400 UpdateNotAllowedOnPausedDatabase : l’utilisateur a tenté d’effectuer une mise à jour sur une base de données en pause.
404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable
404 SourceDatabaseNotFound : la base de données source n’existe pas.
404 DatabaseDoesNotExist : l’utilisateur a spécifié un nom de base de données qui n’existe pas sur ce serveur instance.
404 ResourceDoesNotExist : la ressource portant le nom «{0} » n’existe pas. Pour continuer, spécifiez un nom de ressource valide.
503 DatabaseUnavailable : l’opération a échoué car la base de données n’est pas disponible.

Exemples

Filter managed database columns

List managed database columns

Filter managed database columns

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/serverName/databases/myDatabase/columns?schema=dbo&table=customer&table=address&column=username&orderBy=schema asc&orderBy=table&orderBy=column desc&api-version=2021-11-01


import java.util.Arrays;

/**
 * Samples for ManagedDatabaseColumns ListByDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedColumnsListByDatabaseMax.json
     */
    /**
     * Sample code: Filter managed database columns.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void filterManagedDatabaseColumns(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedDatabaseColumns().listByDatabase("myRG", "serverName",
            "myDatabase", Arrays.asList("dbo"), Arrays.asList("customer", "address"), Arrays.asList("username"),
            Arrays.asList("schema asc", "table", "column desc"), null, com.azure.core.util.Context.NONE);
    }
}

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

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "properties": {
        "columnType": "nvarchar",
        "temporalType": "NonTemporalTable",
        "memoryOptimized": false,
        "isComputed": false
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/serverName/databases/myDatabase/schemas/dbo/tables/customer/columns/username",
      "name": "username",
      "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns"
    }
  ]
}

List managed database columns

Exemple de requête

HTTP
Java

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/serverName/databases/myDatabase/columns?api-version=2021-11-01


/**
 * Samples for ManagedDatabaseColumns ListByDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedColumnsListByDatabaseMin.json
     */
    /**
     * Sample code: List managed database columns.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listManagedDatabaseColumns(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedDatabaseColumns().listByDatabase("myRG", "serverName",
            "myDatabase", null, null, null, null, null, com.azure.core.util.Context.NONE);
    }
}

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

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "properties": {
        "columnType": "int",
        "temporalType": "NonTemporalTable",
        "memoryOptimized": false,
        "isComputed": false
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/serverName/databases/myDatabase/schemas/dbo/tables/table1/columns/col1",
      "name": "col1",
      "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns"
    },
    {
      "properties": {
        "columnType": "bit",
        "temporalType": "SystemVersionedTemporalTable",
        "memoryOptimized": false,
        "isComputed": false
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/serverName/databases/myDatabase/schemas/dbo/tables/table1/columns/col2",
      "name": "col2",
      "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns"
    }
  ]
}

Définitions

Nom	Description
ColumnDataType	Type de données de colonne.
DatabaseColumn	Une ressource de colonne de base de données.
DatabaseColumnListResult	Liste des colonnes de base de données.
TableTemporalType	Type temporel de table.

ColumnDataType

Enumeration

Type de données de colonne.

Valeur	Description
bigint
binary
bit
char
date
datetime
datetime2
datetimeoffset
decimal
float
geography
geometry
hierarchyid
image
int
money
nchar
ntext
numeric
nvarchar
real
smalldatetime
smallint
smallmoney
sql_variant
sysname
text
time
timestamp
tinyint
uniqueidentifier
varbinary
varchar
xml

DatabaseColumn

Object

Une ressource de colonne de base de données.

Nom	Type	Description
id	string	ID de la ressource
name	string	Nom de la ressource.
properties.columnType	ColumnDataType	Type de données de colonne.
properties.isComputed	boolean	Indique si la colonne est calculée ou non.
properties.memoryOptimized	boolean	Indique si la colonne appartient ou non à une table à mémoire optimisée.
properties.temporalType	TableTemporalType	Type temporel de table.
type	string	Type de ressource.

DatabaseColumnListResult

Object

Liste des colonnes de base de données.

Nom	Type	Description
nextLink	string	Lien pour récupérer la page de résultats suivante.
value	DatabaseColumn[]	Tableau de résultats.

TableTemporalType

Enumeration

Type temporel de table.

Valeur	Description
HistoryTable
NonTemporalTable
SystemVersionedTemporalTable

Partager via

Managed Database Columns - List By Database

Paramètres URI

Réponses

Exemples

Filter managed database columns

Exemple de requête

Exemple de réponse

List managed database columns

Exemple de requête

Exemple de réponse

Définitions

ColumnDataType

DatabaseColumn

DatabaseColumnListResult

TableTemporalType

Ressources supplémentaires