AuthenticationPoliciesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:authentication_policies> attribute.

Constructor

AuthenticationPoliciesOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates an authentication policy with the specified name within a resource group.
delete	Deletes the specified authentication policy.
get	Retrieve the authentication policy with specified name within a resource group.
list	Lists all of the authentication policies within a resource group.
list_all	Gets all the authentication policies in a subscription.
update	Updates the tags and identity of an authentication policy.

begin_create_or_update

Creates or updates an authentication policy with the specified name within a resource group.

begin_create_or_update(resource_group_name: str, authentication_policy_name: str, resource: _models.AuthenticationPolicy, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.AuthenticationPolicy]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
authentication_policy_name Required	str The name of the authentication policy. Required.
resource Required	AuthenticationPolicy or AuthenticationPolicy or IO[bytes] Authentication policy to be created or updated. Is either a AuthenticationPolicy type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[AuthenticationPolicy]	An instance of LROPoller that returns AuthenticationPolicy. The AuthenticationPolicy is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

delete

Deletes the specified authentication policy.

delete(resource_group_name: str, authentication_policy_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
authentication_policy_name Required	str The name of the authentication policy. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

get

Retrieve the authentication policy with specified name within a resource group.

get(resource_group_name: str, authentication_policy_name: str, **kwargs: Any) -> AuthenticationPolicy

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
authentication_policy_name Required	str The name of the authentication policy. Required.

Returns

Type	Description
AuthenticationPolicy	AuthenticationPolicy. The AuthenticationPolicy is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list

Lists all of the authentication policies within a resource group.

list(resource_group_name: str, **kwargs: Any) -> ItemPaged[AuthenticationPolicy]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Returns

Type	Description
ItemPaged[AuthenticationPolicy]	An iterator like instance of AuthenticationPolicy

Exceptions

Type	Description
HttpResponseError

list_all

Gets all the authentication policies in a subscription.

list_all(**kwargs: Any) -> ItemPaged[AuthenticationPolicy]

Returns

Type	Description
ItemPaged[AuthenticationPolicy]	An iterator like instance of AuthenticationPolicy

Exceptions

Type	Description
HttpResponseError

update

Updates the tags and identity of an authentication policy.

update(resource_group_name: str, authentication_policy_name: str, parameters: _models.AuthenticationPolicyUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AuthenticationPolicy

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
authentication_policy_name Required	str The name of the authentication policy. Required.
parameters Required	AuthenticationPolicyUpdateParameters or AuthenticationPolicyUpdateParameters or IO[bytes] Parameters supplied to update the authentication policy. Is either a AuthenticationPolicyUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AuthenticationPolicy	AuthenticationPolicy. The AuthenticationPolicy is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError