PrivateEndpointsOperations Class

PrivateEndpointsOperations 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

PrivateEndpointsOperations

Constructor

PrivateEndpointsOperations(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_delete	Delete the specified private endpoint.
create_or_update	Creates a Stream Analytics Private Endpoint or replaces an already existing Private Endpoint.
get	Gets information about the specified Private Endpoint.
list_by_cluster	Lists the private endpoints in the cluster.

begin_delete

Delete the specified private endpoint.

begin_delete(resource_group_name: str, cluster_name: str, private_endpoint_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

cluster_name

str

Required

The name of the cluster.

private_endpoint_name

str

Required

The name of the private endpoint.

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 None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

HttpResponseError

create_or_update

Creates a Stream Analytics Private Endpoint or replaces an already existing Private Endpoint.

create_or_update(resource_group_name: str, cluster_name: str, private_endpoint_name: str, private_endpoint: models.PrivateEndpoint, if_match: Optional[str] = None, if_none_match: Optional[str] = None, **kwargs: Any) -> models.PrivateEndpoint

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

cluster_name

str

Required

The name of the cluster.

private_endpoint_name

str

Required

The name of the private endpoint.

private_endpoint

<xref:stream_analytics_management_client.models.PrivateEndpoint>

Required

The definition of the private endpoint that will be used to create a new cluster or replace the existing one.

if_match

str

default value: None

The ETag of the resource. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

if_none_match

str

default value: None

Set to '*' to allow a new resource to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response.

cls

callable

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

Returns

PrivateEndpoint, or the result of cls(response)

Return type

<xref:stream_analytics_management_client.models.PrivateEndpoint>

Exceptions

HttpResponseError

get

Gets information about the specified Private Endpoint.

get(resource_group_name: str, cluster_name: str, private_endpoint_name: str, **kwargs: Any) -> models.PrivateEndpoint

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

cluster_name

str

Required

The name of the cluster.

private_endpoint_name

str

Required

The name of the private endpoint.

cls

callable

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

Returns

PrivateEndpoint, or the result of cls(response)

Return type

<xref:stream_analytics_management_client.models.PrivateEndpoint>

Exceptions

HttpResponseError

list_by_cluster

Lists the private endpoints in the cluster.

list_by_cluster(resource_group_name: str, cluster_name: str, **kwargs: Any) -> Iterable[models.PrivateEndpointListResult]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

cluster_name

str

Required

The name of the cluster.

cls

callable

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

Returns

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

Return type

ItemPaged[<xref:stream_analytics_management_client.models.PrivateEndpointListResult>]

Exceptions

HttpResponseError

Attributes

models

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