azure.mgmt.sqlvirtualmachine.operations module¶

class azure.mgmt.sqlvirtualmachine.operations.AvailabilityGroupListenersOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlVirtualMachineManagementClient’s availability_group_listeners attribute.

begin_create_or_update(resource_group_name: str, sql_virtual_machine_group_name: str, availability_group_listener_name: str, parameters: _models.AvailabilityGroupListener, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.AvailabilityGroupListener][source]¶

begin_create_or_update(resource_group_name: str, sql_virtual_machine_group_name: str, availability_group_listener_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.AvailabilityGroupListener]

Creates or updates an availability group listener.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_group_name (str) – Name of the SQL virtual machine group. Required.
availability_group_listener_name (str) – Name of the availability group listener. Required.
parameters (AvailabilityGroupListener or IO) – The availability group listener. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either AvailabilityGroupListener or the result of cls(response)

Return type

LROPoller[AvailabilityGroupListener]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, sql_virtual_machine_group_name: str, availability_group_listener_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes an availability group listener.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_group_name (str) – Name of the SQL virtual machine group. Required.
availability_group_listener_name (str) – Name of the availability group listener. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, sql_virtual_machine_group_name: str, availability_group_listener_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.sqlvirtualmachine.models._models_py3.AvailabilityGroupListener[source]¶

Gets an availability group listener.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_group_name (str) – Name of the SQL virtual machine group. Required.
availability_group_listener_name (str) – Name of the availability group listener. Required.
expand (str) – The child resources to include in the response. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AvailabilityGroupListener or the result of cls(response)

Return type

AvailabilityGroupListener

Raises

HttpResponseError –

list_by_group(resource_group_name: str, sql_virtual_machine_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.sqlvirtualmachine.models._models_py3.AvailabilityGroupListener][source]¶

Lists all availability group listeners in a SQL virtual machine group.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_group_name (str) – Name of the SQL virtual machine group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either AvailabilityGroupListener or the result of cls(response)

Return type

ItemPaged[AvailabilityGroupListener]

Raises

HttpResponseError –

models = <module 'azure.mgmt.sqlvirtualmachine.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sqlvirtualmachine/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sqlvirtualmachine/models/__init__.py'>¶

class azure.mgmt.sqlvirtualmachine.operations.Operations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlVirtualMachineManagementClient’s operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.sqlvirtualmachine.models._models_py3.Operation][source]¶

Lists all of the available SQL Virtual Machine Rest API operations.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either Operation or the result of cls(response)
Return type: ItemPaged[Operation]
Raises: HttpResponseError –

models = <module 'azure.mgmt.sqlvirtualmachine.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sqlvirtualmachine/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sqlvirtualmachine/models/__init__.py'>¶

class azure.mgmt.sqlvirtualmachine.operations.SqlVirtualMachineGroupsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlVirtualMachineManagementClient’s sql_virtual_machine_groups attribute.

begin_create_or_update(resource_group_name: str, sql_virtual_machine_group_name: str, parameters: _models.SqlVirtualMachineGroup, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlVirtualMachineGroup][source]¶

begin_create_or_update(resource_group_name: str, sql_virtual_machine_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlVirtualMachineGroup]

Creates or updates a SQL virtual machine group.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_group_name (str) – Name of the SQL virtual machine group. Required.
parameters (SqlVirtualMachineGroup or IO) – The SQL virtual machine group. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either SqlVirtualMachineGroup or the result of cls(response)

Return type

LROPoller[SqlVirtualMachineGroup]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, sql_virtual_machine_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes a SQL virtual machine group.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_group_name (str) – Name of the SQL virtual machine group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, sql_virtual_machine_group_name: str, parameters: _models.SqlVirtualMachineGroupUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlVirtualMachineGroup][source]¶

begin_update(resource_group_name: str, sql_virtual_machine_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlVirtualMachineGroup]

Updates SQL virtual machine group tags.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_group_name (str) – Name of the SQL virtual machine group. Required.
parameters (SqlVirtualMachineGroupUpdate or IO) – The SQL virtual machine group. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either SqlVirtualMachineGroup or the result of cls(response)

Return type

LROPoller[SqlVirtualMachineGroup]

Raises

HttpResponseError –

get(resource_group_name: str, sql_virtual_machine_group_name: str, **kwargs: Any) → azure.mgmt.sqlvirtualmachine.models._models_py3.SqlVirtualMachineGroup[source]¶

Gets a SQL virtual machine group.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_group_name (str) – Name of the SQL virtual machine group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SqlVirtualMachineGroup or the result of cls(response)

Return type

SqlVirtualMachineGroup

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.sqlvirtualmachine.models._models_py3.SqlVirtualMachineGroup][source]¶

Gets all SQL virtual machine groups in a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SqlVirtualMachineGroup or the result of cls(response)
Return type: ItemPaged[SqlVirtualMachineGroup]
Raises: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.sqlvirtualmachine.models._models_py3.SqlVirtualMachineGroup][source]¶

Gets all SQL virtual machine groups in a resource group.

Parameters: resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SqlVirtualMachineGroup or the result of cls(response)
Return type: ItemPaged[SqlVirtualMachineGroup]
Raises: HttpResponseError –

models = <module 'azure.mgmt.sqlvirtualmachine.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sqlvirtualmachine/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sqlvirtualmachine/models/__init__.py'>¶

class azure.mgmt.sqlvirtualmachine.operations.SqlVirtualMachineTroubleshootOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlVirtualMachineManagementClient’s sql_virtual_machine_troubleshoot attribute.

begin_troubleshoot(resource_group_name: str, sql_virtual_machine_name: str, parameters: _models.SqlVmTroubleshooting, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlVmTroubleshooting][source]¶

begin_troubleshoot(resource_group_name: str, sql_virtual_machine_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlVmTroubleshooting]

Starts SQL virtual machine troubleshooting.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_name (str) – Name of the SQL virtual machine. Required.
parameters (SqlVmTroubleshooting or IO) – The SQL virtual machine troubleshooting entity. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either SqlVmTroubleshooting or the result of cls(response)

Return type

LROPoller[SqlVmTroubleshooting]

Raises

HttpResponseError –

models = <module 'azure.mgmt.sqlvirtualmachine.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sqlvirtualmachine/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sqlvirtualmachine/models/__init__.py'>¶

class azure.mgmt.sqlvirtualmachine.operations.SqlVirtualMachinesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlVirtualMachineManagementClient’s sql_virtual_machines attribute.

begin_create_or_update(resource_group_name: str, sql_virtual_machine_name: str, parameters: _models.SqlVirtualMachine, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlVirtualMachine][source]¶

begin_create_or_update(resource_group_name: str, sql_virtual_machine_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlVirtualMachine]

Creates or updates a SQL virtual machine.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_name (str) – Name of the SQL virtual machine. Required.
parameters (SqlVirtualMachine or IO) – The SQL virtual machine. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either SqlVirtualMachine or the result of cls(response)

Return type

LROPoller[SqlVirtualMachine]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, sql_virtual_machine_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes a SQL virtual machine.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_name (str) – Name of the SQL virtual machine. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_redeploy(resource_group_name: str, sql_virtual_machine_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Uninstalls and reinstalls the SQL IaaS Extension.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_name (str) – Name of the SQL virtual machine. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_start_assessment(resource_group_name: str, sql_virtual_machine_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Starts SQL best practices Assessment on SQL virtual machine.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_name (str) – Name of the SQL virtual machine. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, sql_virtual_machine_name: str, parameters: _models.SqlVirtualMachineUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlVirtualMachine][source]¶

begin_update(resource_group_name: str, sql_virtual_machine_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlVirtualMachine]

Updates a SQL virtual machine.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_name (str) – Name of the SQL virtual machine. Required.
parameters (SqlVirtualMachineUpdate or IO) – The SQL virtual machine. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either SqlVirtualMachine or the result of cls(response)

Return type

LROPoller[SqlVirtualMachine]

Raises

HttpResponseError –

get(resource_group_name: str, sql_virtual_machine_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.sqlvirtualmachine.models._models_py3.SqlVirtualMachine[source]¶

Gets a SQL virtual machine.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_name (str) – Name of the SQL virtual machine. Required.
expand (str) – The child resources to include in the response. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SqlVirtualMachine or the result of cls(response)

Return type

SqlVirtualMachine

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.sqlvirtualmachine.models._models_py3.SqlVirtualMachine][source]¶

Gets all SQL virtual machines in a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SqlVirtualMachine or the result of cls(response)
Return type: ItemPaged[SqlVirtualMachine]
Raises: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.sqlvirtualmachine.models._models_py3.SqlVirtualMachine][source]¶

Gets all SQL virtual machines in a resource group.

Parameters: resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SqlVirtualMachine or the result of cls(response)
Return type: ItemPaged[SqlVirtualMachine]
Raises: HttpResponseError –

list_by_sql_vm_group(resource_group_name: str, sql_virtual_machine_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.sqlvirtualmachine.models._models_py3.SqlVirtualMachine][source]¶

Gets the list of sql virtual machines in a SQL virtual machine group.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_group_name (str) – Name of the SQL virtual machine group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SqlVirtualMachine or the result of cls(response)

Return type

ItemPaged[SqlVirtualMachine]

Raises

HttpResponseError –

models = <module 'azure.mgmt.sqlvirtualmachine.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sqlvirtualmachine/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sqlvirtualmachine/models/__init__.py'>¶