Share via

WorkspaceNamedValueOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ApiManagementClient's

<xref:workspace_named_value> attribute.

Constructor

WorkspaceNamedValueOperations(*args, **kwargs)

Methods

begin_create_or_update

Creates or updates named value.
begin_refresh_secret

Refresh the secret of the named value specified by its identifier.
begin_update

Updates the specific named value.
delete

Deletes specific named value from the workspace in an API Management service instance.
get

Gets the details of the named value specified by its identifier.
get_entity_tag

Gets the entity state (Etag) version of the named value specified by its identifier.
list_by_service

Lists a collection of named values defined within a workspace in a service instance.
list_value

Gets the secret of the named value specified by its identifier.

begin_create_or_update

Creates or updates named value.

async begin_create_or_update(resource_group_name: str, service_name: str, workspace_id: str, named_value_id: str, parameters: _models.NamedValueCreateContract, if_match: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.NamedValueContract]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
service_name
Required
str

The name of the API Management service. Required.
workspace_id
Required
str

Workspace identifier. Must be unique in the current API Management service instance. Required.
named_value_id
Required
str

Identifier of the NamedValue. Required.
parameters
Required
NamedValueCreateContract or IO[bytes]

Create parameters. Is either a NamedValueCreateContract type or a IO[bytes] type. Required.
if_match
str

ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Default value: None

Returns

Type Description
AsyncLROPoller[NamedValueContract]

An instance of AsyncLROPoller that returns either NamedValueContract or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_refresh_secret

Refresh the secret of the named value specified by its identifier.

async begin_refresh_secret(resource_group_name: str, service_name: str, workspace_id: str, named_value_id: str, **kwargs: Any) -> AsyncLROPoller[NamedValueContract]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
service_name
Required
str

The name of the API Management service. Required.
workspace_id
Required
str

Workspace identifier. Must be unique in the current API Management service instance. Required.
named_value_id
Required
str

Identifier of the NamedValue. Required.

Returns

Type Description
AsyncLROPoller[NamedValueContract]

An instance of AsyncLROPoller that returns either NamedValueContract or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_update

Updates the specific named value.

async begin_update(resource_group_name: str, service_name: str, workspace_id: str, named_value_id: str, if_match: str, parameters: _models.NamedValueUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.NamedValueContract]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
service_name
Required
str

The name of the API Management service. Required.
workspace_id
Required
str

Workspace identifier. Must be unique in the current API Management service instance. Required.
named_value_id
Required
str

Identifier of the NamedValue. Required.
if_match
Required
str

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. Required.
parameters
Required
NamedValueUpdateParameters or IO[bytes]

Update parameters. Is either a NamedValueUpdateParameters type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[NamedValueContract]

An instance of AsyncLROPoller that returns either NamedValueContract or the result of cls(response)

Exceptions

Type Description
HttpResponseError

delete

Deletes specific named value from the workspace in an API Management service instance.

async delete(resource_group_name: str, service_name: str, workspace_id: str, named_value_id: str, if_match: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
service_name
Required
str

The name of the API Management service. Required.
workspace_id
Required
str

Workspace identifier. Must be unique in the current API Management service instance. Required.
named_value_id
Required
str

Identifier of the NamedValue. Required.
if_match
Required
str

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets the details of the named value specified by its identifier.

async get(resource_group_name: str, service_name: str, workspace_id: str, named_value_id: str, **kwargs: Any) -> NamedValueContract

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
service_name
Required
str

The name of the API Management service. Required.
workspace_id
Required
str

Workspace identifier. Must be unique in the current API Management service instance. Required.
named_value_id
Required
str

Identifier of the NamedValue. Required.

Returns

Type Description
NamedValueContract

NamedValueContract or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_entity_tag

Gets the entity state (Etag) version of the named value specified by its identifier.

async get_entity_tag(resource_group_name: str, service_name: str, workspace_id: str, named_value_id: str, **kwargs: Any) -> bool

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
service_name
Required
str

The name of the API Management service. Required.
workspace_id
Required
str

Workspace identifier. Must be unique in the current API Management service instance. Required.
named_value_id
Required
str

Identifier of the NamedValue. Required.

Returns

Type Description
bool

bool or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_service

Lists a collection of named values defined within a workspace in a service instance.

list_by_service(resource_group_name: str, service_name: str, workspace_id: str, filter: str | None = None, top: int | None = None, skip: int | None = None, is_key_vault_refresh_failed: str | KeyVaultRefreshState | None = None, **kwargs: Any) -> AsyncIterable[NamedValueContract]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
service_name
Required
str

The name of the API Management service. Required.
workspace_id
Required
str

Workspace identifier. Must be unique in the current API Management service instance. Required.
filter
str

Field | Usage | Supported operators | Supported

functions >>|
|<<————->>|-------------|<<————->>|-------------|
|<< tags | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all >>|
|<< displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith

|<<
. Default value is None.

Default value: None
top
int

Number of records to return. Default value is None.

Default value: None
skip
int

Number of records to skip. Default value is None.

Default value: None
is_key_vault_refresh_failed
str or KeyVaultRefreshState

Query parameter to fetch named value entities based on refresh status. Known values are: "true" and "false". Default value is None.

Default value: None

Returns

Type Description
AsyncItemPaged[NamedValueContract]

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

Exceptions

Type Description
HttpResponseError
See also

list_value

Gets the secret of the named value specified by its identifier.

async list_value(resource_group_name: str, service_name: str, workspace_id: str, named_value_id: str, **kwargs: Any) -> NamedValueSecretContract

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
service_name
Required
str

The name of the API Management service. Required.
workspace_id
Required
str

Workspace identifier. Must be unique in the current API Management service instance. Required.
named_value_id
Required
str

Identifier of the NamedValue. Required.

Returns

Type Description
NamedValueSecretContract

NamedValueSecretContract or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

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