SignalRService Class

Definition

Namespace:

Azure.Provisioning.SignalR

Assembly:

Azure.Provisioning.SignalR.dll

Package:

Azure.Provisioning.SignalR v1.0.0-beta.1

Source:

SignalRService.cs

SignalRService.

public class SignalRService : Azure.Provisioning.Primitives.Resource

type SignalRService = class
    inherit Resource

Public Class SignalRService
Inherits Resource

Inheritance

Object

Provisionable

ProvisioningConstruct

NamedProvisioningConstruct

Resource

SignalRService

Constructors

SignalRService(String, String)

Creates a new SignalRService.

Properties

CorsAllowedOrigins	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.
DependsOn	Declares explicit dependencies on other resources. (Inherited from Resource)
DisableAadAuth	DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.
DisableLocalAuth	DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work.
ExternalIP	The publicly accessible IP of the resource.
Features	List of the featureFlags. 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, its globally default value will be used But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags.
HostName	FQDN of the service instance.
HostNamePrefix	Deprecated.
Id	Gets the Id.
IdentifierName	Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores. (Inherited from NamedProvisioningConstruct)
Identity	A class represent managed identities used for request and response. Current supported identity types: None, SystemAssigned, UserAssigned.
IsClientCertEnabled	Request client certificate during TLS handshake if enabled.
IsExistingResource	Gets whether this is referencing an existing resource or we're defining a new resource. (Inherited from Resource)
Kind	The kind of the service, it can be SignalR or RawWebSockets.
LiveTraceConfiguration	Live trace configuration of a Microsoft.SignalRService resource.
Location	Gets or sets the Location.
Name	The name of the resource.
NetworkACLs	Network ACLs for the resource.
PrivateEndpointConnections	Private endpoint connections to the resource.
ProvisioningState	Provisioning state of the resource.
PublicNetworkAccess	Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs.
PublicPort	The publicly accessible port of the resource which is designed for browser/client side usage.
ResourceLogCategories	Gets or sets the list of category configurations.
ResourceType	Gets the type of the resource. (Inherited from Resource)
ResourceVersion	Gets or sets the version of the resource. (Inherited from Resource)
ServerPort	The publicly accessible port of the resource which is designed for customer server side usage.
SharedPrivateLinkResources	The list of shared private link resources.
Sku	The billing information of the resource.
SystemData	Gets the SystemData.
Tags	Gets or sets the Tags.
UpstreamTemplates	Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.
Version	Version of the resource. Probably you need the same or higher version of client SDKs.

Methods

Build(ProvisioningContext)	Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly. (Inherited from Resource)
Compile()	Compile the resource into a set of Bicep statements. (Inherited from Resource)
CreateRoleAssignment(SignalRBuiltInRole, BicepValue<RoleManagementPrincipalType>, BicepValue<Guid>, String)	Creates a role assignment for a principal that grants access to this SignalRService.
CreateRoleAssignment(SignalRBuiltInRole, UserAssignedIdentity)	Creates a role assignment for a user-assigned identity that grants access to this SignalRService.
FromExisting(String, String)	Creates a reference to an existing SignalRService.
GetKeys()	Get access keys for this SignalRService resource.
GetResources()	Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable)
OverrideWithExpression(Expression)	Set this construct to represent the result of an expression. This is primarily meant to be called via FromExpression static methods on specific resources or constructs. (Inherited from ProvisioningConstruct)
Resolve(ProvisioningContext)	Resolve any resources or properties that were not explicitly specified. (Inherited from ProvisioningConstruct)
Validate(ProvisioningContext)	Validate the presence of any required members. (Inherited from Resource)