PrivateEndpointConnectionsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

StorageManagementClient's

<xref:private_endpoint_connections> attribute.

Inheritance
builtins.object
PrivateEndpointConnectionsOperations

Constructor

PrivateEndpointConnectionsOperations(*args, **kwargs)

Methods

delete

Deletes the specified private endpoint connection associated with the storage account.
get

Gets the specified private endpoint connection associated with the storage account.
list

List all the private endpoint connections associated with the storage account.
put

Update the state of specified private endpoint connection associated with the storage account.

delete

Deletes the specified private endpoint connection associated with the storage account.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. The name is case insensitive. Required.
account_name
Required
str

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. Required.
private_endpoint_connection_name
Required
str

The name of the private endpoint connection associated with the Azure resource. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets the specified private endpoint connection associated with the storage account.

get(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> PrivateEndpointConnection

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. The name is case insensitive. Required.
account_name
Required
str

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. Required.
private_endpoint_connection_name
Required
str

The name of the private endpoint connection associated with the Azure resource. Required.

Returns

Type Description
PrivateEndpointConnection

PrivateEndpointConnection or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

List all the private endpoint connections associated with the storage account.

list(resource_group_name: str, account_name: str, **kwargs: Any) -> Iterable[PrivateEndpointConnection]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. The name is case insensitive. Required.
account_name
Required
str

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. Required.

Returns

Type Description
ItemPaged[PrivateEndpointConnection]

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

Exceptions

Type Description
HttpResponseError

put

Update the state of specified private endpoint connection associated with the storage account.

put(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, properties: _models.PrivateEndpointConnection, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PrivateEndpointConnection

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. The name is case insensitive. Required.
account_name
Required
str

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. Required.
private_endpoint_connection_name
Required
str

The name of the private endpoint connection associated with the Azure resource. Required.
properties
Required
PrivateEndpointConnection or IO[bytes]

The private endpoint connection properties. Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.

Returns

Type Description
PrivateEndpointConnection

PrivateEndpointConnection or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.storage.v2023_05_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2023_05_01\\models\\__init__.py'>