azure.mgmt.relay.operations module¶

class azure.mgmt.relay.operations.HybridConnectionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RelayAPI’s hybrid_connections attribute.

create_or_update(resource_group_name: str, namespace_name: str, hybrid_connection_name: str, parameters: _models.HybridConnection, *, content_type: str = "'application/json'", **kwargs: Any) → _models.HybridConnection[source]¶

create_or_update(resource_group_name: str, namespace_name: str, hybrid_connection_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.HybridConnection

Creates or updates a service hybrid connection. This operation is idempotent.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
hybrid_connection_name (str) – The hybrid connection name. Required.
parameters (HybridConnection or IO) – Parameters supplied to create a hybrid connection. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

HybridConnection or the result of cls(response)

Return type

HybridConnection

Raises

HttpResponseError –

create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, hybrid_connection_name: str, authorization_rule_name: str, parameters: _models.AuthorizationRule, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AuthorizationRule[source]¶

create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, hybrid_connection_name: str, authorization_rule_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AuthorizationRule

Creates or updates an authorization rule for a hybrid connection.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
hybrid_connection_name (str) – The hybrid connection name. Required.
authorization_rule_name (str) – The authorization rule name. Required.
parameters (AuthorizationRule or IO) – The authorization rule parameters. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

AuthorizationRule or the result of cls(response)

Return type

AuthorizationRule

Raises

HttpResponseError –

delete(resource_group_name: str, namespace_name: str, hybrid_connection_name: str, **kwargs: Any) → None [source]¶

Deletes a hybrid connection.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
hybrid_connection_name (str) – The hybrid connection name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

delete_authorization_rule(resource_group_name: str, namespace_name: str, hybrid_connection_name: str, authorization_rule_name: str, **kwargs: Any) → None [source]¶

Deletes a hybrid connection authorization rule.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
hybrid_connection_name (str) – The hybrid connection name. Required.
authorization_rule_name (str) – The authorization rule name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, namespace_name: str, hybrid_connection_name: str, **kwargs: Any) → azure.mgmt.relay.models._models_py3.HybridConnection[source]¶

Returns the description for the specified hybrid connection.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
hybrid_connection_name (str) – The hybrid connection name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

HybridConnection or the result of cls(response)

Return type

HybridConnection

Raises

HttpResponseError –

get_authorization_rule(resource_group_name: str, namespace_name: str, hybrid_connection_name: str, authorization_rule_name: str, **kwargs: Any) → azure.mgmt.relay.models._models_py3.AuthorizationRule[source]¶

Hybrid connection authorization rule for a hybrid connection by name.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
hybrid_connection_name (str) – The hybrid connection name. Required.
authorization_rule_name (str) – The authorization rule name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AuthorizationRule or the result of cls(response)

Return type

AuthorizationRule

Raises

HttpResponseError –

list_authorization_rules(resource_group_name: str, namespace_name: str, hybrid_connection_name: str, **kwargs: Any) → Iterable[azure.mgmt.relay.models._models_py3.AuthorizationRule][source]¶

Authorization rules for a hybrid connection.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
hybrid_connection_name (str) – The hybrid connection name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[AuthorizationRule]

Raises

HttpResponseError –

list_by_namespace(resource_group_name: str, namespace_name: str, **kwargs: Any) → Iterable[azure.mgmt.relay.models._models_py3.HybridConnection][source]¶

Lists the hybrid connection within the namespace.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[HybridConnection]

Raises

HttpResponseError –

list_keys(resource_group_name: str, namespace_name: str, hybrid_connection_name: str, authorization_rule_name: str, **kwargs: Any) → azure.mgmt.relay.models._models_py3.AccessKeys[source]¶

Primary and secondary connection strings to the hybrid connection.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
hybrid_connection_name (str) – The hybrid connection name. Required.
authorization_rule_name (str) – The authorization rule name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AccessKeys or the result of cls(response)

Return type

Raises

HttpResponseError –

regenerate_keys(resource_group_name: str, namespace_name: str, hybrid_connection_name: str, authorization_rule_name: str, parameters: _models.RegenerateAccessKeyParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessKeys[source]¶

regenerate_keys(resource_group_name: str, namespace_name: str, hybrid_connection_name: str, authorization_rule_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessKeys

Regenerates the primary or secondary connection strings to the hybrid connection.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
hybrid_connection_name (str) – The hybrid connection name. Required.
authorization_rule_name (str) – The authorization rule name. Required.
parameters (RegenerateAccessKeyParameters or IO) – Parameters supplied to regenerate authorization rule. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

AccessKeys or the result of cls(response)

Return type

Raises

HttpResponseError –

models = <module 'azure.mgmt.relay.models' from '/mnt/vss/_work/1/s/sdk/relay/azure-mgmt-relay/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/relay/models/__init__.py'>¶

class azure.mgmt.relay.operations.NamespacesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RelayAPI’s namespaces attribute.

begin_create_or_update(resource_group_name: str, namespace_name: str, parameters: _models.RelayNamespace, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RelayNamespace][source]¶

begin_create_or_update(resource_group_name: str, namespace_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RelayNamespace]

Create Azure Relay namespace.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
parameters (RelayNamespace or IO) – Parameters supplied to create a namespace resource. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 RelayNamespace or the result of cls(response)

Return type

LROPoller[RelayNamespace]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, namespace_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes an existing namespace. This operation also removes all associated resources under the namespace.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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]

Raises

HttpResponseError –

check_name_availability(parameters: _models.CheckNameAvailability, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityResult[source]¶

check_name_availability(parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityResult

Check the specified namespace name availability.

Parameters

parameters (CheckNameAvailability or IO) – Parameters to check availability of the specified namespace name. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

CheckNameAvailabilityResult or the result of cls(response)

Return type

CheckNameAvailabilityResult

Raises

HttpResponseError –

create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: _models.AuthorizationRule, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AuthorizationRule[source]¶

create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AuthorizationRule

Creates or updates an authorization rule for a namespace.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
authorization_rule_name (str) – The authorization rule name. Required.
parameters (AuthorizationRule or IO) – The authorization rule parameters. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

AuthorizationRule or the result of cls(response)

Return type

AuthorizationRule

Raises

HttpResponseError –

create_or_update_network_rule_set(resource_group_name: str, namespace_name: str, parameters: _models.NetworkRuleSet, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NetworkRuleSet[source]¶

create_or_update_network_rule_set(resource_group_name: str, namespace_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NetworkRuleSet

Create or update NetworkRuleSet for a Namespace.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
parameters (NetworkRuleSet or IO) – The Namespace IpFilterRule. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

NetworkRuleSet or the result of cls(response)

Return type

Raises

HttpResponseError –

delete_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) → None [source]¶

Deletes a namespace authorization rule.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
authorization_rule_name (str) – The authorization rule name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, namespace_name: str, **kwargs: Any) → azure.mgmt.relay.models._models_py3.RelayNamespace[source]¶

Returns the description for the specified namespace.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RelayNamespace or the result of cls(response)

Return type

Raises

HttpResponseError –

get_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) → azure.mgmt.relay.models._models_py3.AuthorizationRule[source]¶

Authorization rule for a namespace by name.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
authorization_rule_name (str) – The authorization rule name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AuthorizationRule or the result of cls(response)

Return type

AuthorizationRule

Raises

HttpResponseError –

get_network_rule_set(resource_group_name: str, namespace_name: str, **kwargs: Any) → azure.mgmt.relay.models._models_py3.NetworkRuleSet[source]¶

Gets NetworkRuleSet for a Namespace.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

NetworkRuleSet or the result of cls(response)

Return type

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.relay.models._models_py3.RelayNamespace][source]¶

Lists all the available namespaces within the subscription regardless of the resourceGroups.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either RelayNamespace or the result of cls(response)
Return type: ItemPaged[RelayNamespace]
Raises: HttpResponseError –

list_authorization_rules(resource_group_name: str, namespace_name: str, **kwargs: Any) → Iterable[azure.mgmt.relay.models._models_py3.AuthorizationRule][source]¶

Authorization rules for a namespace.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[AuthorizationRule]

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.relay.models._models_py3.RelayNamespace][source]¶

Lists all the available namespaces within the ResourceGroup.

Parameters: resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either RelayNamespace or the result of cls(response)
Return type: ItemPaged[RelayNamespace]
Raises: HttpResponseError –

list_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) → azure.mgmt.relay.models._models_py3.AccessKeys[source]¶

Primary and secondary connection strings to the namespace.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
authorization_rule_name (str) – The authorization rule name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AccessKeys or the result of cls(response)

Return type

Raises

HttpResponseError –

regenerate_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: _models.RegenerateAccessKeyParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessKeys[source]¶

regenerate_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessKeys

Regenerates the primary or secondary connection strings to the namespace.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
authorization_rule_name (str) – The authorization rule name. Required.
parameters (RegenerateAccessKeyParameters or IO) – Parameters supplied to regenerate authorization rule. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

AccessKeys or the result of cls(response)

Return type

Raises

HttpResponseError –

update(resource_group_name: str, namespace_name: str, parameters: _models.RelayUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RelayNamespace[source]¶

update(resource_group_name: str, namespace_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RelayNamespace

Creates or updates a namespace. Once created, this namespace’s resource manifest is immutable. This operation is idempotent.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
parameters (RelayUpdateParameters or IO) – Parameters for updating a namespace resource. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

RelayNamespace or the result of cls(response)

Return type

Raises

HttpResponseError –

models = <module 'azure.mgmt.relay.models' from '/mnt/vss/_work/1/s/sdk/relay/azure-mgmt-relay/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/relay/models/__init__.py'>¶

class azure.mgmt.relay.operations.Operations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RelayAPI’s operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.relay.models._models_py3.Operation][source]¶

Lists all available Relay REST API operations.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either Operation or the result of cls(response)
Return type: ItemPaged[Operation]
Raises: HttpResponseError –

models = <module 'azure.mgmt.relay.models' from '/mnt/vss/_work/1/s/sdk/relay/azure-mgmt-relay/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/relay/models/__init__.py'>¶

class azure.mgmt.relay.operations.PrivateEndpointConnectionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RelayAPI’s private_endpoint_connections attribute.

begin_delete(resource_group_name: str, namespace_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes an existing namespace. This operation also removes all associated resources under the namespace.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
private_endpoint_connection_name (str) – The PrivateEndpointConnection name. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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]

Raises

HttpResponseError –

create_or_update(resource_group_name: str, namespace_name: str, private_endpoint_connection_name: str, parameters: _models.PrivateEndpointConnection, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PrivateEndpointConnection[source]¶

create_or_update(resource_group_name: str, namespace_name: str, private_endpoint_connection_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PrivateEndpointConnection

Creates or updates PrivateEndpointConnections of service namespace.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
private_endpoint_connection_name (str) – The PrivateEndpointConnection name. Required.
parameters (PrivateEndpointConnection or IO) – Parameters supplied to update Status of PrivateEndPoint Connection to namespace resource. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

PrivateEndpointConnection or the result of cls(response)

Return type

PrivateEndpointConnection

Raises

HttpResponseError –

get(resource_group_name: str, namespace_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.mgmt.relay.models._models_py3.PrivateEndpointConnection[source]¶

Gets a description for the specified Private Endpoint Connection name.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
private_endpoint_connection_name (str) – The PrivateEndpointConnection name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PrivateEndpointConnection or the result of cls(response)

Return type

PrivateEndpointConnection

Raises

HttpResponseError –

list(resource_group_name: str, namespace_name: str, **kwargs: Any) → Iterable[azure.mgmt.relay.models._models_py3.PrivateEndpointConnection][source]¶

Gets the available PrivateEndpointConnections within a namespace.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[PrivateEndpointConnection]

Raises

HttpResponseError –

models = <module 'azure.mgmt.relay.models' from '/mnt/vss/_work/1/s/sdk/relay/azure-mgmt-relay/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/relay/models/__init__.py'>¶

class azure.mgmt.relay.operations.PrivateLinkResourcesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RelayAPI’s private_link_resources attribute.

get(resource_group_name: str, namespace_name: str, private_link_resource_name: str, **kwargs: Any) → azure.mgmt.relay.models._models_py3.PrivateLinkResource[source]¶

Gets a description for the specified Private Endpoint Connection name.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
private_link_resource_name (str) – The PrivateLinkResource name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PrivateLinkResource or the result of cls(response)

Return type

PrivateLinkResource

Raises

HttpResponseError –

list(resource_group_name: str, namespace_name: str, **kwargs: Any) → azure.mgmt.relay.models._models_py3.PrivateLinkResourcesListResult[source]¶

Gets lists of resources that supports Privatelinks.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PrivateLinkResourcesListResult or the result of cls(response)

Return type

PrivateLinkResourcesListResult

Raises

HttpResponseError –

models = <module 'azure.mgmt.relay.models' from '/mnt/vss/_work/1/s/sdk/relay/azure-mgmt-relay/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/relay/models/__init__.py'>¶

class azure.mgmt.relay.operations.WCFRelaysOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RelayAPI’s wcf_relays attribute.

create_or_update(resource_group_name: str, namespace_name: str, relay_name: str, parameters: _models.WcfRelay, *, content_type: str = "'application/json'", **kwargs: Any) → _models.WcfRelay[source]¶

create_or_update(resource_group_name: str, namespace_name: str, relay_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.WcfRelay

Creates or updates a WCF relay. This operation is idempotent.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
relay_name (str) – The relay name. Required.
parameters (WcfRelay or IO) – Parameters supplied to create a WCF relay. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

WcfRelay or the result of cls(response)

Return type

Raises

HttpResponseError –

create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, relay_name: str, authorization_rule_name: str, parameters: _models.AuthorizationRule, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AuthorizationRule[source]¶

create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, relay_name: str, authorization_rule_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AuthorizationRule

Creates or updates an authorization rule for a WCF relay.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
relay_name (str) – The relay name. Required.
authorization_rule_name (str) – The authorization rule name. Required.
parameters (AuthorizationRule or IO) – The authorization rule parameters. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

AuthorizationRule or the result of cls(response)

Return type

AuthorizationRule

Raises

HttpResponseError –

delete(resource_group_name: str, namespace_name: str, relay_name: str, **kwargs: Any) → None [source]¶

Deletes a WCF relay.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
relay_name (str) – The relay name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

delete_authorization_rule(resource_group_name: str, namespace_name: str, relay_name: str, authorization_rule_name: str, **kwargs: Any) → None [source]¶

Deletes a WCF relay authorization rule.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
relay_name (str) – The relay name. Required.
authorization_rule_name (str) – The authorization rule name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, namespace_name: str, relay_name: str, **kwargs: Any) → Optional[azure.mgmt.relay.models._models_py3.WcfRelay][source]¶

Returns the description for the specified WCF relay.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
relay_name (str) – The relay name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

WcfRelay or None or the result of cls(response)

Return type

WcfRelay or None

Raises

HttpResponseError –

get_authorization_rule(resource_group_name: str, namespace_name: str, relay_name: str, authorization_rule_name: str, **kwargs: Any) → azure.mgmt.relay.models._models_py3.AuthorizationRule[source]¶

Get authorizationRule for a WCF relay by name.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
relay_name (str) – The relay name. Required.
authorization_rule_name (str) – The authorization rule name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AuthorizationRule or the result of cls(response)

Return type

AuthorizationRule

Raises

HttpResponseError –

list_authorization_rules(resource_group_name: str, namespace_name: str, relay_name: str, **kwargs: Any) → Iterable[azure.mgmt.relay.models._models_py3.AuthorizationRule][source]¶

Authorization rules for a WCF relay.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
relay_name (str) – The relay name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[AuthorizationRule]

Raises

HttpResponseError –

list_by_namespace(resource_group_name: str, namespace_name: str, **kwargs: Any) → Iterable[azure.mgmt.relay.models._models_py3.WcfRelay][source]¶

Lists the WCF relays within the namespace.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[WcfRelay]

Raises

HttpResponseError –

list_keys(resource_group_name: str, namespace_name: str, relay_name: str, authorization_rule_name: str, **kwargs: Any) → azure.mgmt.relay.models._models_py3.AccessKeys[source]¶

Primary and secondary connection strings to the WCF relay.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
relay_name (str) – The relay name. Required.
authorization_rule_name (str) – The authorization rule name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AccessKeys or the result of cls(response)

Return type

Raises

HttpResponseError –

regenerate_keys(resource_group_name: str, namespace_name: str, relay_name: str, authorization_rule_name: str, parameters: _models.RegenerateAccessKeyParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessKeys[source]¶

regenerate_keys(resource_group_name: str, namespace_name: str, relay_name: str, authorization_rule_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessKeys

Regenerates the primary or secondary connection strings to the WCF relay.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.
namespace_name (str) – The namespace name. Required.
relay_name (str) – The relay name. Required.
authorization_rule_name (str) – The authorization rule name. Required.
parameters (RegenerateAccessKeyParameters or IO) – Parameters supplied to regenerate authorization rule. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

AccessKeys or the result of cls(response)

Return type

Raises

HttpResponseError –

models = <module 'azure.mgmt.relay.models' from '/mnt/vss/_work/1/s/sdk/relay/azure-mgmt-relay/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/relay/models/__init__.py'>¶