azure.mgmt.signalr.models module

exception azure.mgmt.signalr.models.ErrorResponseException(deserialize, response, *args)[source]

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘ErrorResponse’.

Parameters

  • deserialize – A deserializer

  • response – Server response to be deserialized.

class azure.mgmt.signalr.models.Dimension(*, name: str = None, display_name: str = None, internal_name: str = None, to_be_exported_for_shoebox: bool = None, **kwargs)[source]

Bases: msrest.serialization.Model

Specifications of the Dimension of metrics.

Parameters

  • name (str) – The public facing name of the dimension.

  • display_name (str) – Localized friendly display name of the dimension.

  • internal_name (str) – Name of the dimension as it appears in MDM.

  • to_be_exported_for_shoebox (bool) – A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.

class azure.mgmt.signalr.models.ErrorResponse(*, error=None, **kwargs)[source]

Bases: msrest.serialization.Model

Contains information about an API error.

Parameters

error (ErrorResponseBody) – Describes a particular API error with an error code and a message.

class azure.mgmt.signalr.models.ErrorResponseBody(*, code: str, message: str, target: str = None, details=None, **kwargs)[source]

Bases: msrest.serialization.Model

Describes a particular API error with an error code and a message.

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

Parameters

  • code (str) – Required. An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases.

  • message (str) – Required. A message that describes the error in detail and provides debugging information.

  • target (str) – The target of the particular error (for example, the name of the property in error).

  • details (list[ErrorResponseBody]) – Contains nested errors that are related to this error.

class azure.mgmt.signalr.models.LogSpecification(*, name: str = None, display_name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Specifications of the Logs for Azure Monitoring.

Parameters

  • name (str) – Name of the log.

  • display_name (str) – Localized friendly display name of the log.

class azure.mgmt.signalr.models.MetricSpecification(*, name: str = None, display_name: str = None, display_description: str = None, unit: str = None, aggregation_type: str = None, fill_gap_with_zero: str = None, category: str = None, dimensions=None, **kwargs)[source]

Bases: msrest.serialization.Model

Specifications of the Metrics for Azure Monitoring.

Parameters

  • name (str) – Name of the metric.

  • display_name (str) – Localized friendly display name of the metric.

  • display_description (str) – Localized friendly description of the metric.

  • unit (str) – The unit that makes sense for the metric.

  • aggregation_type (str) – Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.

  • fill_gap_with_zero (str) – Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. Ex. a metric that returns the number of times a particular error code was emitted. The error code may not appear often, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.

  • category (str) – The name of the metric category that the metric belongs to. A metric can only belong to a single category.

  • dimensions (list[Dimension]) – The dimensions of the metrics.

class azure.mgmt.signalr.models.NameAvailability(*, name_available: bool = None, reason: str = None, message: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Result of the request to check name availability. It contains a flag and possible reason of failure.

Parameters

  • name_available (bool) – Indicates whether the name is available or not.

  • reason (str) – The reason of the availability. Required if name is not available.

  • message (str) – The message of the operation.

class azure.mgmt.signalr.models.NameAvailabilityParameters(*, type: str, name: str, **kwargs)[source]

Bases: msrest.serialization.Model

Data POST-ed to the nameAvailability action.

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

Parameters

  • type (str) – Required. The resource type. Should be always “Microsoft.SignalRService/SignalR”.

  • name (str) – Required. The SignalR service name to validate. e.g.”my-signalR-name-here”

class azure.mgmt.signalr.models.NetworkACL(*, allow=None, deny=None, **kwargs)[source]

Bases: msrest.serialization.Model

Network ACL.

Parameters

  • allow (list[str or SignalRRequestType]) – Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

  • deny (list[str or SignalRRequestType]) – Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

class azure.mgmt.signalr.models.Operation(*, name: str = None, is_data_action: bool = None, display=None, origin: str = None, properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

REST API operation supported by SignalR resource provider.

Parameters

  • name (str) – Name of the operation with format: {provider}/{resource}/{operation}

  • is_data_action (bool) – If the operation is a data action. (for data plane rbac)

  • display (OperationDisplay) – The object that describes the operation.

  • origin (str) – Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.

  • properties (OperationProperties) – Extra properties for the operation.

class azure.mgmt.signalr.models.OperationDisplay(*, provider: str = None, resource: str = None, operation: str = None, description: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The object that describes a operation.

Parameters

  • provider (str) – Friendly name of the resource provider

  • resource (str) – Resource type on which the operation is performed.

  • operation (str) – The localized friendly name for the operation.

  • description (str) – The localized friendly description for the operation

class azure.mgmt.signalr.models.OperationProperties(*, service_specification=None, **kwargs)[source]

Bases: msrest.serialization.Model

Extra Operation properties.

Parameters

service_specification (ServiceSpecification) – The service specifications.

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

Bases: msrest.serialization.Model

Private endpoint.

Parameters

id (str) – Full qualified Id of the private endpoint

class azure.mgmt.signalr.models.PrivateEndpointACL(*, name: str, allow=None, deny=None, **kwargs)[source]

Bases: azure.mgmt.signalr.models._models_py3.NetworkACL

ACL for a private endpoint.

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

Parameters

  • allow (list[str or SignalRRequestType]) – Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

  • deny (list[str or SignalRRequestType]) – Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

  • name (str) – Required. Name of the private endpoint connection

class azure.mgmt.signalr.models.PrivateEndpointConnection(*, private_endpoint=None, private_link_service_connection_state=None, **kwargs)[source]

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

A private endpoint connection to SignalR 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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource - e.g. “Microsoft.SignalRService/SignalR”

  • provisioning_state (str or ProvisioningState) – Provisioning state of the private endpoint connection. Possible values include: ‘Unknown’, ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘Running’, ‘Creating’, ‘Updating’, ‘Deleting’, ‘Moving’

Parameters
class azure.mgmt.signalr.models.PrivateLinkResource(*, group_id: str = None, required_members=None, required_zone_names=None, **kwargs)[source]

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

Private link 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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource - e.g. “Microsoft.SignalRService/SignalR”

Parameters

  • group_id (str) – Group Id of the private link resource

  • required_members (list[str]) – Required members of the private link resource

  • required_zone_names (list[str]) – Required private DNS zone names

class azure.mgmt.signalr.models.PrivateLinkServiceConnectionState(*, status=None, description: str = None, actions_required: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Connection state of the private endpoint connection.

Parameters

  • status (str or PrivateLinkServiceConnectionStatus) – Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Possible values include: ‘Pending’, ‘Approved’, ‘Rejected’, ‘Disconnected’

  • description (str) – The reason for approval/rejection of the connection.

  • actions_required (str) – A message indicating if changes on the service provider require any updates on the consumer.

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

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

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource - e.g. “Microsoft.SignalRService/SignalR”

class azure.mgmt.signalr.models.RegenerateKeyParameters(*, key_type=None, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters describes the request to regenerate access keys.

Parameters

key_type (str or KeyType) – The keyType to regenerate. Must be either ‘primary’ or ‘secondary’(case-insensitive). Possible values include: ‘Primary’, ‘Secondary’

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

Bases: msrest.serialization.Model

The core properties of ARM 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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource - e.g. “Microsoft.SignalRService/SignalR”

class azure.mgmt.signalr.models.ResourceSku(*, name: str, tier=None, size: str = None, family: str = None, capacity: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

The billing information of the SignalR resource.

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

Parameters

  • name (str) – Required. The name of the SKU. Required. Allowed values: Standard_S1, Free_F1

  • tier (str or SignalRSkuTier) – Optional tier of this particular SKU. ‘Standard’ or ‘Free’. Basic is deprecated, use Standard instead. Possible values include: ‘Free’, ‘Basic’, ‘Standard’, ‘Premium’

  • size (str) – Optional string. For future use.

  • family (str) – Optional string. For future use.

  • capacity (int) – Optional, integer. The unit count of SignalR resource. 1 by default. If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100

class azure.mgmt.signalr.models.ServerlessUpstreamSettings(*, templates=None, **kwargs)[source]

Bases: msrest.serialization.Model

The settings for the Upstream when the Azure SignalR is in server-less mode.

Parameters

templates (list[UpstreamTemplate]) – Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.

class azure.mgmt.signalr.models.ServiceSpecification(*, metric_specifications=None, log_specifications=None, **kwargs)[source]

Bases: msrest.serialization.Model

An object that describes a specification.

Parameters
class azure.mgmt.signalr.models.SignalRCorsSettings(*, allowed_origins=None, **kwargs)[source]

Bases: msrest.serialization.Model

Cross-Origin Resource Sharing (CORS) settings.

Parameters

allowed_origins (list[str]) – Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use “*” to allow all. If omitted, allow all by default.

class azure.mgmt.signalr.models.SignalRCreateOrUpdateProperties(*, host_name_prefix: str = None, features=None, cors=None, upstream=None, network_ac_ls=None, **kwargs)[source]

Bases: msrest.serialization.Model

Settings used to provision or configure the resource.

Parameters

  • host_name_prefix (str) – Prefix for the hostName of the SignalR service. Retained for future use. The hostname will be of format: <hostNamePrefix>.service.signalr.net.

  • features (list[SignalRFeature]) – List of SignalR featureFlags. e.g. ServiceMode. FeatureFlags that are not included in the parameters for the update operation will not be modified. And the response will only include featureFlags that are explicitly set. When a featureFlag is not explicitly set, SignalR service will use its globally default value. But keep in mind, the default value doesn’t mean “false”. It varies in terms of different FeatureFlags.

  • cors (SignalRCorsSettings) – Cross-Origin Resource Sharing (CORS) settings.

  • upstream (ServerlessUpstreamSettings) – Upstream settings when the Azure SignalR is in server-less mode.

  • network_ac_ls (SignalRNetworkACLs) – Network ACLs

class azure.mgmt.signalr.models.SignalRFeature(*, flag, value: str, properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

Feature of a SignalR resource, which controls the SignalR runtime behavior.

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

Parameters

  • flag (str or FeatureFlags) – Required. FeatureFlags is the supported features of Azure SignalR service. - ServiceMode: Flag for backend server for SignalR service. Values allowed: “Default”: have your own backend server; “Serverless”: your application doesn’t have a backend server; “Classic”: for backward compatibility. Support both Default and Serverless mode but not recommended; “PredefinedOnly”: for future use. - EnableConnectivityLogs: “true”/”false”, to enable/disable the connectivity log category respectively. Possible values include: ‘ServiceMode’, ‘EnableConnectivityLogs’, ‘EnableMessagingLogs’

  • value (str) – Required. Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values.

  • properties (dict[str, str]) – Optional properties related to this feature.

class azure.mgmt.signalr.models.SignalRKeys(*, primary_key: str = None, secondary_key: str = None, primary_connection_string: str = None, secondary_connection_string: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

A class represents the access keys of SignalR service.

Parameters

  • primary_key (str) – The primary access key.

  • secondary_key (str) – The secondary access key.

  • primary_connection_string (str) – SignalR connection string constructed via the primaryKey

  • secondary_connection_string (str) – SignalR connection string constructed via the secondaryKey

class azure.mgmt.signalr.models.SignalRNetworkACLs(*, default_action=None, public_network=None, private_endpoints=None, **kwargs)[source]

Bases: msrest.serialization.Model

Network ACLs for SignalR.

Parameters

  • default_action (str or ACLAction) – Default action when no other rule matches. Possible values include: ‘Allow’, ‘Deny’

  • public_network (NetworkACL) – ACL for requests from public network

  • private_endpoints (list[PrivateEndpointACL]) – ACLs for requests from private endpoints

class azure.mgmt.signalr.models.SignalRResource(*, location: str = None, tags=None, sku=None, host_name_prefix: str = None, features=None, cors=None, upstream=None, network_ac_ls=None, kind=None, **kwargs)[source]

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

A class represent a SignalR service 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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource - e.g. “Microsoft.SignalRService/SignalR”

  • provisioning_state (str or ProvisioningState) – Provisioning state of the resource. Possible values include: ‘Unknown’, ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘Running’, ‘Creating’, ‘Updating’, ‘Deleting’, ‘Moving’

  • external_ip (str) – The publicly accessible IP of the SignalR service.

  • host_name (str) – FQDN of the SignalR service instance. Format: xxx.service.signalr.net

  • public_port (int) – The publicly accessible port of the SignalR service which is designed for browser/client side usage.

  • server_port (int) – The publicly accessible port of the SignalR service which is designed for customer server side usage.

  • version (str) – Version of the SignalR resource. Probably you need the same or higher version of client SDKs.

  • private_endpoint_connections (list[PrivateEndpointConnection]) – Private endpoint connections to the SignalR resource.

Parameters

  • location (str) – The GEO location of the SignalR service. e.g. West US | East US | North Central US | South Central US.

  • tags (dict[str, str]) – Tags of the service which is a list of key value pairs that describe the resource.

  • sku (ResourceSku) – The billing information of the resource.(e.g. Free, Standard)

  • host_name_prefix (str) – Prefix for the hostName of the SignalR service. Retained for future use. The hostname will be of format: <hostNamePrefix>.service.signalr.net.

  • features (list[SignalRFeature]) – List of SignalR featureFlags. e.g. ServiceMode. FeatureFlags that are not included in the parameters for the update operation will not be modified. And the response will only include featureFlags that are explicitly set. When a featureFlag is not explicitly set, SignalR service will use its globally default value. But keep in mind, the default value doesn’t mean “false”. It varies in terms of different FeatureFlags.

  • cors (SignalRCorsSettings) – Cross-Origin Resource Sharing (CORS) settings.

  • upstream (ServerlessUpstreamSettings) – Upstream settings when the Azure SignalR is in server-less mode.

  • network_ac_ls (SignalRNetworkACLs) – Network ACLs

  • kind (str or ServiceKind) – The kind of the service - e.g. “SignalR”, or “RawWebSockets” for “Microsoft.SignalRService/SignalR”. Possible values include: ‘SignalR’, ‘RawWebSockets’

class azure.mgmt.signalr.models.SignalRUsage(*, id: str = None, current_value: int = None, limit: int = None, name=None, unit: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Object that describes a specific usage of SignalR resources.

Parameters

  • id (str) – Fully qualified ARM resource id

  • current_value (long) – Current value for the usage quota.

  • limit (long) – The maximum permitted value for the usage quota. If there is no limit, this value will be -1.

  • name (SignalRUsageName) – Localizable String object containing the name and a localized value.

  • unit (str) – Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond.

class azure.mgmt.signalr.models.SignalRUsageName(*, value: str = None, localized_value: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Localizable String object containing the name and a localized value.

Parameters

  • value (str) – The identifier of the usage.

  • localized_value (str) – Localized name of the usage.

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

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

The resource model definition for a ARM tracked top level 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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource - e.g. “Microsoft.SignalRService/SignalR”

Parameters

  • location (str) – The GEO location of the SignalR service. e.g. West US | East US | North Central US | South Central US.

  • tags (dict[str, str]) – Tags of the service which is a list of key value pairs that describe the resource.

class azure.mgmt.signalr.models.UpstreamTemplate(*, url_template: str, hub_pattern: str = None, event_pattern: str = None, category_pattern: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Upstream template item settings. It defines the Upstream URL of the incoming requests. The template defines the pattern of the event, the hub or the category of the incoming request that matches current URL template.

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

Parameters

  • hub_pattern (str) – Gets or sets the matching pattern for hub names. If not set, it matches any hub. There are 3 kind of patterns supported: 1. “*”, it to matches any hub name 2. Combine multiple hubs with “,”, for example “hub1,hub2”, it matches “hub1” and “hub2” 3. The single hub name, for example, “hub1”, it matches “hub1”

  • event_pattern (str) – Gets or sets the matching pattern for event names. If not set, it matches any event. There are 3 kind of patterns supported: 1. “*”, it to matches any event name 2. Combine multiple events with “,”, for example “connect,disconnect”, it matches event “connect” and “disconnect” 3. The single event name, for example, “connect”, it matches “connect”

  • category_pattern (str) – Gets or sets the matching pattern for category names. If not set, it matches any category. There are 3 kind of patterns supported: 1. “*”, it to matches any category name 2. Combine multiple categories with “,”, for example “connections,messages”, it matches category “connections” and “messages” 3. The single category name, for example, “connections”, it matches the category “connections”

  • url_template (str) – Required. Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. For example, if the urlTemplate is http://example.com/{hub}/api/{event}, with a client request from hub chat connects, it will first POST to this URL: http://example.com/chat/api/connect.

class azure.mgmt.signalr.models.OperationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.signalr.models.SignalRResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of SignalRResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.signalr.models.PrivateLinkResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of PrivateLinkResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.signalr.models.SignalRUsagePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of SignalRUsage object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.signalr.models.SignalRSkuTier[source]

Bases: str, enum.Enum

An enumeration.

basic = 'Basic'
free = 'Free'
premium = 'Premium'
standard = 'Standard'
class azure.mgmt.signalr.models.ProvisioningState[source]

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'
creating = 'Creating'
deleting = 'Deleting'
failed = 'Failed'
moving = 'Moving'
running = 'Running'
succeeded = 'Succeeded'
unknown = 'Unknown'
updating = 'Updating'
class azure.mgmt.signalr.models.PrivateLinkServiceConnectionStatus[source]

Bases: str, enum.Enum

An enumeration.

approved = 'Approved'
disconnected = 'Disconnected'
pending = 'Pending'
rejected = 'Rejected'
class azure.mgmt.signalr.models.ServiceKind[source]

Bases: str, enum.Enum

An enumeration.

raw_web_sockets = 'RawWebSockets'
signal_r = 'SignalR'
class azure.mgmt.signalr.models.FeatureFlags[source]

Bases: str, enum.Enum

An enumeration.

enable_connectivity_logs = 'EnableConnectivityLogs'
enable_messaging_logs = 'EnableMessagingLogs'
service_mode = 'ServiceMode'
class azure.mgmt.signalr.models.ACLAction[source]

Bases: str, enum.Enum

An enumeration.

allow = 'Allow'
deny = 'Deny'
class azure.mgmt.signalr.models.SignalRRequestType[source]

Bases: str, enum.Enum

An enumeration.

client_connection = 'ClientConnection'
restapi = 'RESTAPI'
server_connection = 'ServerConnection'
class azure.mgmt.signalr.models.KeyType[source]

Bases: str, enum.Enum

An enumeration.

primary = 'Primary'
secondary = 'Secondary'