SecretsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DevTestLabsClient's

secrets attribute.

Constructor

SecretsOperations(*args, **kwargs)

Methods

begin_create_or_update

Create or replace an existing secret. This operation can take a while to complete.
delete

Delete secret.
get

Get secret.
list

List secrets in a given user profile.
update

Allows modifying tags of secrets. All other properties will be ignored.

begin_create_or_update

Create or replace an existing secret. This operation can take a while to complete.

begin_create_or_update(resource_group_name: str, lab_name: str, user_name: str, name: str, secret: _models.Secret, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Secret]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
user_name
Required
str

The name of the user profile. Required.
name
Required
str

The name of the secret. Required.
secret
Required
Secret or IO[bytes]

A secret. Is either a Secret type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[Secret]

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

Exceptions

Type Description
HttpResponseError

delete

Delete secret.

delete(resource_group_name: str, lab_name: str, user_name: str, name: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
user_name
Required
str

The name of the user profile. Required.
name
Required
str

The name of the secret. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Get secret.

get(resource_group_name: str, lab_name: str, user_name: str, name: str, expand: str | None = None, **kwargs: Any) -> Secret

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
user_name
Required
str

The name of the user profile. Required.
name
Required
str

The name of the secret. Required.
expand
str

Specify the $expand query. Example: 'properties($select=value)'. Default value is None.

Default value: None

Returns

Type Description
Secret

Secret or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

List secrets in a given user profile.

list(resource_group_name: str, lab_name: str, user_name: str, expand: str | None = None, filter: str | None = None, top: int | None = None, orderby: str | None = None, **kwargs: Any) -> ItemPaged[Secret]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
user_name
Required
str

The name of the user profile. Required.
expand
str

Specify the $expand query. Example: 'properties($select=value)'. Default value is None.

Default value: None
filter
str

The filter to apply to the operation. Example: '$filter=contains(name,'myName'). Default value is None.

Default value: None
top
int

The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

Default value: None
orderby
str

The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. Default value is None.

Default value: None

Returns

Type Description
ItemPaged[Secret]

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

Exceptions

Type Description
HttpResponseError

update

Allows modifying tags of secrets. All other properties will be ignored.

update(resource_group_name: str, lab_name: str, user_name: str, name: str, tags: dict[str, str] | None = None, **kwargs: Any) -> Secret

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
user_name
Required
str

The name of the user profile. Required.
name
Required
str

The name of the secret. Required.
tags
dict[str, str]

The tags of the resource. Default value is None.

Default value: None

Returns

Type Description
Secret

Secret or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.devtestlabs.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv125\\Lib\\site-packages\\azure\\mgmt\\devtestlabs\\models\\__init__.py'>