TestBaseAccountsOperations Class

TestBaseAccountsOperations 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
TestBaseAccountsOperations

Constructor

TestBaseAccountsOperations(client, config, serializer, deserializer)

Parameters

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

models

Alias to model classes used in this operation group.

Methods

begin_create

Create or replace (overwrite/recreate, with potential downtime) a Test Base Account in the specified subscription.

begin_delete

Deletes a Test Base Account.

begin_offboard

Offboard a Test Base Account.

begin_update

Update an existing Test Base Account.

check_package_name_availability

Checks that the Test Base Package name and version is valid and is not already in use.

get

Gets a Test Base Account.

get_file_upload_url

Gets the file upload URL of a Test Base Account.

list_by_resource_group

Lists all the Test Base Accounts in a resource group.

list_by_subscription

Lists all the Test Base Accounts in a subscription. This API is required by ARM guidelines.

begin_create

Create or replace (overwrite/recreate, with potential downtime) a Test Base Account in the specified subscription.

begin_create(resource_group_name: str, test_base_account_name: str, parameters: _models.TestBaseAccountResource, restore: Optional[bool] = None, **kwargs: Any) -> LROPoller[_models.TestBaseAccountResource]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource.

test_base_account_name
str
Required

The resource name of the Test Base Account.

parameters
<xref:test_base.models.TestBaseAccountResource>
Required

Parameters supplied to create a Test Base Account.

restore
bool
default value: None

The flag indicating if we would like to restore the Test Base Accounts which were soft deleted before.

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 TestBaseAccountResource or the result of cls(response)

Return type

LROPoller[<xref:test_base.models.TestBaseAccountResource>]

Exceptions

begin_delete

Deletes a Test Base Account.

begin_delete(resource_group_name: str, test_base_account_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource.

test_base_account_name
str
Required

The resource name of the Test Base Account.

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

Exceptions

begin_offboard

Offboard a Test Base Account.

begin_offboard(resource_group_name: str, test_base_account_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource.

test_base_account_name
str
Required

The resource name of the Test Base Account.

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

Exceptions

begin_update

Update an existing Test Base Account.

begin_update(resource_group_name: str, test_base_account_name: str, parameters: _models.TestBaseAccountUpdateParameters, **kwargs: Any) -> LROPoller[_models.TestBaseAccountResource]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource.

test_base_account_name
str
Required

The resource name of the Test Base Account.

parameters
<xref:test_base.models.TestBaseAccountUpdateParameters>
Required

Parameters supplied to update a Test Base Account.

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 TestBaseAccountResource or the result of cls(response)

Return type

LROPoller[<xref:test_base.models.TestBaseAccountResource>]

Exceptions

check_package_name_availability

Checks that the Test Base Package name and version is valid and is not already in use.

check_package_name_availability(resource_group_name: str, test_base_account_name: str, parameters: _models.PackageCheckNameAvailabilityParameters, **kwargs: Any) -> _models.CheckNameAvailabilityResult

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource.

test_base_account_name
str
Required

The resource name of the Test Base Account.

parameters
<xref:test_base.models.PackageCheckNameAvailabilityParameters>
Required

Parameters supplied to the Test Base Package CheckNameAvailability operation.

cls
callable

A custom type or function that will be passed the direct response

Returns

CheckNameAvailabilityResult, or the result of cls(response)

Return type

<xref:test_base.models.CheckNameAvailabilityResult>

Exceptions

get

Gets a Test Base Account.

get(resource_group_name: str, test_base_account_name: str, **kwargs: Any) -> _models.TestBaseAccountResource

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource.

test_base_account_name
str
Required

The resource name of the Test Base Account.

cls
callable

A custom type or function that will be passed the direct response

Returns

TestBaseAccountResource, or the result of cls(response)

Return type

<xref:test_base.models.TestBaseAccountResource>

Exceptions

get_file_upload_url

Gets the file upload URL of a Test Base Account.

get_file_upload_url(resource_group_name: str, test_base_account_name: str, parameters: Optional[_models.GetFileUploadURLParameters] = None, **kwargs: Any) -> _models.FileUploadURLResponse

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource.

test_base_account_name
str
Required

The resource name of the Test Base Account.

parameters
<xref:test_base.models.GetFileUploadURLParameters>
default value: None

Parameters supplied to the Test Base Account GetFileUploadURL operation.

cls
callable

A custom type or function that will be passed the direct response

Returns

FileUploadURLResponse, or the result of cls(response)

Return type

<xref:test_base.models.FileUploadURLResponse>

Exceptions

list_by_resource_group

Lists all the Test Base Accounts in a resource group.

list_by_resource_group(resource_group_name: str, get_deleted: Optional[bool] = None, **kwargs: Any) -> Iterable[_models.TestBaseAccountListResult]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource.

get_deleted
bool
default value: None

The flag indicating if we need to include the Test Base Accounts which were soft deleted before.

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[<xref:test_base.models.TestBaseAccountListResult>]

Exceptions

list_by_subscription

Lists all the Test Base Accounts in a subscription. This API is required by ARM guidelines.

list_by_subscription(get_deleted: Optional[bool] = None, **kwargs: Any) -> Iterable[_models.TestBaseAccountListResult]

Parameters

get_deleted
bool
default value: None

The flag indicating if we need to include the Test Base Accounts which were soft deleted before.

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[<xref:test_base.models.TestBaseAccountListResult>]

Exceptions

Attributes

models

models = <module 'azure.mgmt.testbase.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\testbase\\models\\__init__.py'>