azure.mgmt.relay.models module¶

class azure.mgmt.relay.models.AccessKeys(*, primary_connection_string: Optional[str] = None, secondary_connection_string: Optional[str] = None, primary_key: Optional[str] = None, secondary_key: Optional[str] = None, key_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

Namespace/Relay Connection String.

Variables

primary_connection_string (str) – Primary connection string of the created namespace authorization rule.
secondary_connection_string (str) – Secondary connection string of the created namespace authorization rule.
primary_key (str) – A base64-encoded 256-bit primary key for signing and validating the SAS token.
secondary_key (str) – A base64-encoded 256-bit secondary key for signing and validating the SAS token.
key_name (str) – A string that describes the authorization rule.

Keyword Arguments

primary_connection_string (str) – Primary connection string of the created namespace authorization rule.
secondary_connection_string (str) – Secondary connection string of the created namespace authorization rule.
primary_key (str) – A base64-encoded 256-bit primary key for signing and validating the SAS token.
secondary_key (str) – A base64-encoded 256-bit secondary key for signing and validating the SAS token.
key_name (str) – A string that describes the authorization rule.

class azure.mgmt.relay.models.AccessRights(value)[source]¶

Bases: str, enum.Enum

AccessRights.

LISTEN = 'Listen'¶

MANAGE = 'Manage'¶

SEND = 'Send'¶

class azure.mgmt.relay.models.AuthorizationRule(*, rights: Optional[List[Union[str, _models.AccessRights]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay.models._models_py3.ProxyResource

Single item in a List or Get AuthorizationRule operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”.
location (str) – The geo-location where the resource lives.
system_data (SystemData) – The system meta data relating to this resource.
rights (list[str or AccessRights]) – The rights associated with the rule.

Keyword Arguments

rights (list[str or AccessRights]) – The rights associated with the rule.

class azure.mgmt.relay.models.AuthorizationRuleListResult(*, value: Optional[List[_models.AuthorizationRule]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

The response from the list namespace operation.

Variables

value (list[AuthorizationRule]) – Result of the list authorization rules operation.
next_link (str) – Link to the next set of results. Not empty if value contains incomplete list of authorization rules.

Keyword Arguments

value (list[AuthorizationRule]) – Result of the list authorization rules operation.
next_link (str) – Link to the next set of results. Not empty if value contains incomplete list of authorization rules.

class azure.mgmt.relay.models.CheckNameAvailability(*, name: str, **kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

Description of the check name availability request properties.

All required parameters must be populated in order to send to Azure.

Variables: name (str) – The namespace name to check for availability. The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number. Required.
Keyword Arguments: name (str) – The namespace name to check for availability. The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number. Required.

class azure.mgmt.relay.models.CheckNameAvailabilityResult(*, name_available: Optional[bool] = None, reason: Optional[Union[str, _models.UnavailableReason]] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

Description of the check name availability request properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

message (str) – The detailed info regarding the reason associated with the namespace.
name_available (bool) – Value indicating namespace is available. Returns true if the namespace is available; otherwise, false.
reason (str or UnavailableReason) – The reason for unavailability of a namespace. Known values are: “None”, “InvalidName”, “SubscriptionIsDisabled”, “NameInUse”, “NameInLockdown”, and “TooManyNamespaceInCurrentSubscription”.

Keyword Arguments

name_available (bool) – Value indicating namespace is available. Returns true if the namespace is available; otherwise, false.
reason (str or UnavailableReason) – The reason for unavailability of a namespace. Known values are: “None”, “InvalidName”, “SubscriptionIsDisabled”, “NameInUse”, “NameInLockdown”, and “TooManyNamespaceInCurrentSubscription”.

class azure.mgmt.relay.models.ConnectionState(*, status: Optional[Union[str, _models.PrivateLinkConnectionStatus]] = None, description: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

ConnectionState information.

Variables

status (str or PrivateLinkConnectionStatus) – Status of the connection. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.
description (str) – Description of the connection state.

Keyword Arguments

status (str or PrivateLinkConnectionStatus) – Status of the connection. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.
description (str) – Description of the connection state.

class azure.mgmt.relay.models.CreatedByType(value)[source]¶

Bases: str, enum.Enum

The type of identity that created the resource.

APPLICATION = 'Application'¶

KEY = 'Key'¶

MANAGED_IDENTITY = 'ManagedIdentity'¶

USER = 'User'¶

class azure.mgmt.relay.models.DefaultAction(value)[source]¶

Bases: str, enum.Enum

Default Action for Network Rule Set.

ALLOW = 'Allow'¶

DENY = 'Deny'¶

class azure.mgmt.relay.models.EndPointProvisioningState(value)[source]¶

Bases: str, enum.Enum

Provisioning state of the Private Endpoint Connection.

CANCELED = 'Canceled'¶

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

UPDATING = 'Updating'¶

class azure.mgmt.relay.models.ErrorAdditionalInfo(**kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

The resource management error additional info.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

type (str) – The additional info type.
info (JSON) – The additional info.

class azure.mgmt.relay.models.ErrorDetail(**kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

The error detail.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

code (str) – The error code.
message (str) – The error message.
target (str) – The error target.
details (list[ErrorDetail]) – The error details.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.

class azure.mgmt.relay.models.ErrorResponse(*, error: Optional[_models.ErrorDetail] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables: error (ErrorDetail) – The error object.
Keyword Arguments: error (ErrorDetail) – The error object.

class azure.mgmt.relay.models.HybridConnection(*, requires_client_authorization: Optional[bool] = None, user_metadata: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay.models._models_py3.ProxyResource

Description of hybrid connection resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”.
location (str) – The geo-location where the resource lives.
system_data (SystemData) – The system meta data relating to this resource.
created_at (datetime) – The time the hybrid connection was created.
updated_at (datetime) – The time the namespace was updated.
listener_count (int) – The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported.
requires_client_authorization (bool) – Returns true if client authorization is needed for this hybrid connection; otherwise, false.
user_metadata (str) – The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.

Keyword Arguments

requires_client_authorization (bool) – Returns true if client authorization is needed for this hybrid connection; otherwise, false.
user_metadata (str) – The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.

class azure.mgmt.relay.models.HybridConnectionListResult(*, value: Optional[List[_models.HybridConnection]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

The response of the list hybrid connection operation.

Variables

value (list[HybridConnection]) – Result of the list hybrid connections.
next_link (str) – Link to the next set of results. Not empty if value contains incomplete list hybrid connection operation.

Keyword Arguments

value (list[HybridConnection]) – Result of the list hybrid connections.
next_link (str) – Link to the next set of results. Not empty if value contains incomplete list hybrid connection operation.

class azure.mgmt.relay.models.KeyType(value)[source]¶

Bases: str, enum.Enum

The access key to regenerate.

PRIMARY_KEY = 'PrimaryKey'¶

SECONDARY_KEY = 'SecondaryKey'¶

class azure.mgmt.relay.models.NWRuleSetIpRules(*, ip_mask: Optional[str] = None, action: Optional[Union[str, _models.NetworkRuleIPAction]] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

The response from the List namespace operation.

Variables

ip_mask (str) – IP Mask.
action (str or NetworkRuleIPAction) – The IP Filter Action. “Allow”

Keyword Arguments

ip_mask (str) – IP Mask.
action (str or NetworkRuleIPAction) – The IP Filter Action. “Allow”

class azure.mgmt.relay.models.NetworkRuleIPAction(value)[source]¶

Bases: str, enum.Enum

The IP Filter Action.

ALLOW = 'Allow'¶

class azure.mgmt.relay.models.NetworkRuleSet(*, default_action: Optional[Union[str, _models.DefaultAction]] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, ip_rules: Optional[List[_models.NWRuleSetIpRules]] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay.models._models_py3.Resource

Description of topic resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
system_data (SystemData) – The system meta data relating to this resource.
default_action (str or DefaultAction) – Default Action for Network Rule Set. Known values are: “Allow” and “Deny”.
public_network_access (str or PublicNetworkAccess) – This determines if traffic is allowed over public network. By default it is enabled. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.
ip_rules (list[NWRuleSetIpRules]) – List of IpRules.

Keyword Arguments

default_action (str or DefaultAction) – Default Action for Network Rule Set. Known values are: “Allow” and “Deny”.
public_network_access (str or PublicNetworkAccess) – This determines if traffic is allowed over public network. By default it is enabled. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.
ip_rules (list[NWRuleSetIpRules]) – List of IpRules.

class azure.mgmt.relay.models.Operation(*, properties: Optional[collections.abc.MutableMapping[str, Any]] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

A Relay REST API operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – Operation name: {provider}/{resource}/{operation}.
is_data_action (bool) – Indicates whether the operation is a data action.
display (OperationDisplay) – Display of the operation.
origin (str) – Origin of the operation.
properties (JSON) – Properties of the operation.

Keyword Arguments

properties (JSON) – Properties of the operation.

class azure.mgmt.relay.models.OperationDisplay(**kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

Operation display payload.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

provider (str) – Resource provider of the operation.
resource (str) – Resource of the operation.
operation (str) – Localized friendly name for the operation.
description (str) – Localized friendly description for the operation.

class azure.mgmt.relay.models.OperationListResult(**kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

Result of the request to list Relay operations. It contains a list of operations and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Operation]) – List of Relay operations supported by the Microsoft.Relay resource provider.
next_link (str) – URL to get the next set of operation list results if there are any.

class azure.mgmt.relay.models.PrivateEndpoint(*, id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

PrivateEndpoint information.

Variables: id (str) – The ARM identifier for Private Endpoint.
Keyword Arguments: id (str) – The ARM identifier for Private Endpoint.

class azure.mgmt.relay.models.PrivateEndpointConnection(*, private_endpoint: Optional[_models.PrivateEndpoint] = None, private_link_service_connection_state: Optional[_models.ConnectionState] = None, provisioning_state: Optional[Union[str, _models.EndPointProvisioningState]] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay.models._models_py3.ProxyResource

Properties of the PrivateEndpointConnection.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”.
location (str) – The geo-location where the resource lives.
system_data (SystemData) – The system meta data relating to this resource.
private_endpoint (PrivateEndpoint) – The Private Endpoint resource for this Connection.
private_link_service_connection_state (ConnectionState) – Details about the state of the connection.
provisioning_state (str or EndPointProvisioningState) – Provisioning state of the Private Endpoint Connection. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, and “Failed”.

Keyword Arguments

private_endpoint (PrivateEndpoint) – The Private Endpoint resource for this Connection.
private_link_service_connection_state (ConnectionState) – Details about the state of the connection.
provisioning_state (str or EndPointProvisioningState) – Provisioning state of the Private Endpoint Connection. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, and “Failed”.

class azure.mgmt.relay.models.PrivateEndpointConnectionListResult(*, value: Optional[List[_models.PrivateEndpointConnection]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

Result of the list of all private endpoint connections operation.

Variables

value (list[PrivateEndpointConnection]) – A collection of private endpoint connection resources.
next_link (str) – A link for the next page of private endpoint connection resources.

Keyword Arguments

value (list[PrivateEndpointConnection]) – A collection of private endpoint connection resources.
next_link (str) – A link for the next page of private endpoint connection resources.

class azure.mgmt.relay.models.PrivateLinkConnectionStatus(value)[source]¶

Bases: str, enum.Enum

Status of the connection.

APPROVED = 'Approved'¶

DISCONNECTED = 'Disconnected'¶

PENDING = 'Pending'¶

REJECTED = 'Rejected'¶

class azure.mgmt.relay.models.PrivateLinkResource(*, id: Optional[str] = None, name: Optional[str] = None, type: Optional[str] = None, group_id: Optional[str] = None, required_members: Optional[List[str]] = None, required_zone_names: Optional[List[str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

Information of the private link resource.

Variables

id (str) – Fully qualified identifier of the resource.
name (str) – Name of the resource.
type (str) – Type of the resource.
group_id (str) – The private link resource group id.
required_members (list[str]) – The private link resource required member names.
required_zone_names (list[str]) – The private link resource Private link DNS zone name.

Keyword Arguments

id (str) – Fully qualified identifier of the resource.
name (str) – Name of the resource.
type (str) – Type of the resource.
group_id (str) – The private link resource group id.
required_members (list[str]) – The private link resource required member names.
required_zone_names (list[str]) – The private link resource Private link DNS zone name.

class azure.mgmt.relay.models.PrivateLinkResourcesListResult(*, value: Optional[List[_models.PrivateLinkResource]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

Result of the List private link resources operation.

Variables

value (list[PrivateLinkResource]) – A collection of private link resources.
next_link (str) – A link for the next page of private link resources.

Keyword Arguments

value (list[PrivateLinkResource]) – A collection of private link resources.
next_link (str) – A link for the next page of private link resources.

class azure.mgmt.relay.models.ProxyResource(**kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

Common fields that are returned in the response for all Azure Resource Manager resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”.
location (str) – The geo-location where the resource lives.

class azure.mgmt.relay.models.PublicNetworkAccess(value)[source]¶

Bases: str, enum.Enum

This determines if traffic is allowed over public network. By default it is enabled.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

SECURED_BY_PERIMETER = 'SecuredByPerimeter'¶

class azure.mgmt.relay.models.RegenerateAccessKeyParameters(*, key_type: Union[str, _models.KeyType], key: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

Parameters supplied to the regenerate authorization rule operation, specifies which key needs to be reset.

All required parameters must be populated in order to send to Azure.

Variables

key_type (str or KeyType) – The access key to regenerate. Required. Known values are: “PrimaryKey” and “SecondaryKey”.
key (str) – Optional. If the key value is provided, this is set to key type, or autogenerated key value set for key type.

Keyword Arguments

key_type (str or KeyType) – The access key to regenerate. Required. Known values are: “PrimaryKey” and “SecondaryKey”.
key (str) – Optional. If the key value is provided, this is set to key type, or autogenerated key value set for key type.

class azure.mgmt.relay.models.RelayNamespace(*, location: str, tags: Optional[Dict[str, str]] = None, sku: Optional[_models.Sku] = None, private_endpoint_connections: Optional[List[_models.PrivateEndpointConnection]] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay.models._models_py3.TrackedResource

Description of a namespace resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
sku (Sku) – SKU of the namespace.
system_data (SystemData) – The system meta data relating to this resource.
provisioning_state (str) – Provisioning state of the Namespace.
status (str) – Status of the Namespace.
created_at (datetime) – The time the namespace was created.
updated_at (datetime) – The time the namespace was updated.
service_bus_endpoint (str) – Endpoint you can use to perform Service Bus operations.
metric_id (str) – Identifier for Azure Insights metrics.
private_endpoint_connections (list[PrivateEndpointConnection]) – List of private endpoint connections.
public_network_access (str or PublicNetworkAccess) – This determines if traffic is allowed over public network. By default it is enabled. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.

Keyword Arguments

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
sku (Sku) – SKU of the namespace.
private_endpoint_connections (list[PrivateEndpointConnection]) – List of private endpoint connections.
public_network_access (str or PublicNetworkAccess) – This determines if traffic is allowed over public network. By default it is enabled. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.

class azure.mgmt.relay.models.RelayNamespaceListResult(*, value: Optional[List[_models.RelayNamespace]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

The response from the list namespace operation.

Variables

value (list[RelayNamespace]) – Result of the list namespace operation.
next_link (str) – Link to the next set of results. Not empty if value contains incomplete list of namespaces.

Keyword Arguments

value (list[RelayNamespace]) – Result of the list namespace operation.
next_link (str) – Link to the next set of results. Not empty if value contains incomplete list of namespaces.

class azure.mgmt.relay.models.RelayUpdateParameters(*, tags: Optional[Dict[str, str]] = None, sku: Optional[_models.Sku] = None, private_endpoint_connections: Optional[List[_models.PrivateEndpointConnection]] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay.models._models_py3.ResourceNamespacePatch

Description of a namespace resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
tags (dict[str, str]) – Resource tags.
sku (Sku) – SKU of the namespace.
provisioning_state (str) – Provisioning state of the Namespace.
status (str) – Status of the Namespace.
created_at (datetime) – The time the namespace was created.
updated_at (datetime) – The time the namespace was updated.
service_bus_endpoint (str) – Endpoint you can use to perform Service Bus operations.
metric_id (str) – Identifier for Azure Insights metrics.
private_endpoint_connections (list[PrivateEndpointConnection]) – List of private endpoint connections.
public_network_access (str or PublicNetworkAccess) – This determines if traffic is allowed over public network. By default it is enabled. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.

Keyword Arguments

tags (dict[str, str]) – Resource tags.
sku (Sku) – SKU of the namespace.
private_endpoint_connections (list[PrivateEndpointConnection]) – List of private endpoint connections.
public_network_access (str or PublicNetworkAccess) – This determines if traffic is allowed over public network. By default it is enabled. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.

class azure.mgmt.relay.models.Relaytype(value)[source]¶

Bases: str, enum.Enum

WCF relay type.

HTTP = 'Http'¶

NET_TCP = 'NetTcp'¶

class azure.mgmt.relay.models.Resource(**kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

The resource definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

class azure.mgmt.relay.models.ResourceNamespacePatch(*, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay.models._models_py3.Resource

Definition of resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
tags (dict[str, str]) – Resource tags.

Keyword Arguments

tags (dict[str, str]) – Resource tags.

class azure.mgmt.relay.models.Sku(*, name: Union[str, _models.SkuName], tier: Optional[Union[str, _models.SkuTier]] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

SKU of the namespace.

All required parameters must be populated in order to send to Azure.

Variables

name (str or SkuName) – Name of this SKU. Required. “Standard”
tier (str or SkuTier) – The tier of this SKU. “Standard”

Keyword Arguments

name (str or SkuName) – Name of this SKU. Required. “Standard”
tier (str or SkuTier) – The tier of this SKU. “Standard”

class azure.mgmt.relay.models.SkuName(value)[source]¶

Bases: str, enum.Enum

Name of this SKU.

STANDARD = 'Standard'¶

class azure.mgmt.relay.models.SkuTier(value)[source]¶

Bases: str, enum.Enum

The tier of this SKU.

STANDARD = 'Standard'¶

class azure.mgmt.relay.models.SystemData(*, created_by: Optional[str] = None, created_by_type: Optional[Union[str, _models.CreatedByType]] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str, _models.CreatedByType]] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

Metadata pertaining to creation and last modification of the resource.

Variables

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.relay.models.TrackedResource(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay.models._models_py3.Resource

Definition of resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.

Keyword Arguments

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.

class azure.mgmt.relay.models.UnavailableReason(value)[source]¶

Bases: str, enum.Enum

Specifies the reason for the unavailability of the service.

INVALID_NAME = 'InvalidName'¶

NAME_IN_LOCKDOWN = 'NameInLockdown'¶

NAME_IN_USE = 'NameInUse'¶

NONE = 'None'¶

SUBSCRIPTION_IS_DISABLED = 'SubscriptionIsDisabled'¶

TOO_MANY_NAMESPACE_IN_CURRENT_SUBSCRIPTION = 'TooManyNamespaceInCurrentSubscription'¶

class azure.mgmt.relay.models.WcfRelay(*, relay_type: Optional[Union[str, _models.Relaytype]] = None, requires_client_authorization: Optional[bool] = None, requires_transport_security: Optional[bool] = None, user_metadata: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay.models._models_py3.ProxyResource

Description of the WCF relay resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”.
location (str) – The geo-location where the resource lives.
system_data (SystemData) – The system meta data relating to this resource.
is_dynamic (bool) – Returns true if the relay is dynamic; otherwise, false.
created_at (datetime) – The time the WCF relay was created.
updated_at (datetime) – The time the namespace was updated.
listener_count (int) – The number of listeners for this relay. Note that min :1 and max:25 are supported.
relay_type (str or Relaytype) – WCF relay type. Known values are: “NetTcp” and “Http”.
requires_client_authorization (bool) – Returns true if client authorization is needed for this relay; otherwise, false.
requires_transport_security (bool) – Returns true if transport security is needed for this relay; otherwise, false.
user_metadata (str) – The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.

Keyword Arguments

relay_type (str or Relaytype) – WCF relay type. Known values are: “NetTcp” and “Http”.
requires_client_authorization (bool) – Returns true if client authorization is needed for this relay; otherwise, false.
requires_transport_security (bool) – Returns true if transport security is needed for this relay; otherwise, false.
user_metadata (str) – The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.

class azure.mgmt.relay.models.WcfRelaysListResult(*, value: Optional[List[_models.WcfRelay]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.relay._serialization.Model

The response of the list WCF relay operation.

Variables

value (list[WcfRelay]) – Result of the list WCF relay operation.
next_link (str) – Link to the next set of results. Not empty if value contains incomplete list of WCF relays.

Keyword Arguments

value (list[WcfRelay]) – Result of the list WCF relay operation.
next_link (str) – Link to the next set of results. Not empty if value contains incomplete list of WCF relays.