SecretsOperations Class

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

Constructor

SecretsOperations(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_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, **kwargs: Any) -> LROPoller[_models.Secret]

Parameters

resource_group_name
str
Required

The name of the resource group.

lab_name
str
Required

The name of the lab.

user_name
str
Required

The name of the user profile.

name
str
Required

The name of the secret.

secret
Secret
Required

A secret.

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

True for ARMPolling, False for no polling, or a polling object for 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 Secret or the result of cls(response)

Return type

Exceptions

delete

Delete secret.

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

Parameters

resource_group_name
str
Required

The name of the resource group.

lab_name
str
Required

The name of the lab.

user_name
str
Required

The name of the user profile.

name
str
Required

The name of the secret.

cls
callable

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

Returns

None, or the result of cls(response)

Return type

Exceptions

get

Get secret.

get(resource_group_name: str, lab_name: str, user_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) -> _models.Secret

Parameters

resource_group_name
str
Required

The name of the resource group.

lab_name
str
Required

The name of the lab.

user_name
str
Required

The name of the user profile.

name
str
Required

The name of the secret.

expand
str
default value: None

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

cls
callable

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

Returns

Secret, or the result of cls(response)

Return type

Exceptions

list

List secrets in a given user profile.

list(resource_group_name: str, lab_name: str, user_name: str, expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) -> Iterable[_models.SecretList]

Parameters

resource_group_name
str
Required

The name of the resource group.

lab_name
str
Required

The name of the lab.

user_name
str
Required

The name of the user profile.

expand
str
default value: None

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

filter
str
default value: None

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

top
int
default value: None

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

orderby
str
default value: None

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

cls
callable

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

Returns

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

Return type

Exceptions

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: Optional[Dict[str, str]] = None, value: Optional[str] = None, **kwargs: Any) -> _models.Secret

Parameters

resource_group_name
str
Required

The name of the resource group.

lab_name
str
Required

The name of the lab.

user_name
str
Required

The name of the user profile.

name
str
Required

The name of the secret.

tags
dict[str, str]
default value: None

The tags of the resource.

value
str
default value: None

The value of the secret for secret creation.

cls
callable

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

Returns

Secret, or the result of cls(response)

Return type

Exceptions

Attributes

models

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