DatabaseSchemasOperations Class

DatabaseSchemasOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

DatabaseSchemasOperations

Constructor

DatabaseSchemasOperations(client, config, serializer, deserializer)

Parameters

Name	Description
client Required	Client for service requests.
config Required	Configuration of service client.
serializer Required	An object model serializer.
deserializer Required	An object model deserializer.

Variables

Name	Description
models	Alias to model classes used in this operation group.

Methods

get	Get database schema.
list_by_database	List database schemas.

get

Get database schema.

async get(resource_group_name: str, server_name: str, database_name: str, schema_name: str, **kwargs: Any) -> DatabaseSchema

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name Required	str The name of the server.
database_name Required	str The name of the database.
schema_name Required	str The name of the schema.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
DatabaseSchema	DatabaseSchema, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_database

List database schemas.

list_by_database(resource_group_name: str, server_name: str, database_name: str, filter: str | None = None, **kwargs: Any) -> AsyncIterable[DatabaseSchemaListResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name Required	str The name of the server.
database_name Required	str The name of the database.
filter	str An OData filter expression that filters elements in the collection. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[DatabaseSchemaListResult]	An iterator like instance of either DatabaseSchemaListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>