arm

package
v2.0.0-...-a7294fb Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 20, 2024 License: MIT Imports: 1 Imported by: 0

Documentation

Overview

Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.

Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.

Index

Constants

View Source 
const (
	ServiceKind_RawWebSockets = ServiceKind("RawWebSockets")
	ServiceKind_SignalR       = ServiceKind("SignalR")
)
View Source 
const (
	ManagedIdentityType_None           = ManagedIdentityType("None")
	ManagedIdentityType_SystemAssigned = ManagedIdentityType("SystemAssigned")
	ManagedIdentityType_UserAssigned   = ManagedIdentityType("UserAssigned")
)
View Source 
const (
	SignalRSkuTier_Basic    = SignalRSkuTier("Basic")
	SignalRSkuTier_Free     = SignalRSkuTier("Free")
	SignalRSkuTier_Premium  = SignalRSkuTier("Premium")
	SignalRSkuTier_Standard = SignalRSkuTier("Standard")
)
View Source 
const (
	ACLAction_Allow = ACLAction("Allow")
	ACLAction_Deny  = ACLAction("Deny")
)
View Source 
const (
	FeatureFlags_EnableConnectivityLogs = FeatureFlags("EnableConnectivityLogs")
	FeatureFlags_EnableLiveTrace        = FeatureFlags("EnableLiveTrace")
	FeatureFlags_EnableMessagingLogs    = FeatureFlags("EnableMessagingLogs")
	FeatureFlags_ServiceMode            = FeatureFlags("ServiceMode")
)
View Source 
const (
	SignalRRequestType_ClientConnection = SignalRRequestType("ClientConnection")
	SignalRRequestType_RESTAPI          = SignalRRequestType("RESTAPI")
	SignalRRequestType_ServerConnection = SignalRRequestType("ServerConnection")
	SignalRRequestType_Trace            = SignalRRequestType("Trace")
)
View Source 
const (
	UpstreamAuthType_ManagedIdentity = UpstreamAuthType("ManagedIdentity")
	UpstreamAuthType_None            = UpstreamAuthType("None")
)
View Source 
const (
	ServiceKind_STATUS_RawWebSockets = ServiceKind_STATUS("RawWebSockets")
	ServiceKind_STATUS_SignalR       = ServiceKind_STATUS("SignalR")
)
View Source 
const (
	ManagedIdentityType_STATUS_None           = ManagedIdentityType_STATUS("None")
	ManagedIdentityType_STATUS_SystemAssigned = ManagedIdentityType_STATUS("SystemAssigned")
	ManagedIdentityType_STATUS_UserAssigned   = ManagedIdentityType_STATUS("UserAssigned")
)
View Source 
const (
	ProvisioningState_STATUS_Canceled  = ProvisioningState_STATUS("Canceled")
	ProvisioningState_STATUS_Creating  = ProvisioningState_STATUS("Creating")
	ProvisioningState_STATUS_Deleting  = ProvisioningState_STATUS("Deleting")
	ProvisioningState_STATUS_Failed    = ProvisioningState_STATUS("Failed")
	ProvisioningState_STATUS_Moving    = ProvisioningState_STATUS("Moving")
	ProvisioningState_STATUS_Running   = ProvisioningState_STATUS("Running")
	ProvisioningState_STATUS_Succeeded = ProvisioningState_STATUS("Succeeded")
	ProvisioningState_STATUS_Unknown   = ProvisioningState_STATUS("Unknown")
	ProvisioningState_STATUS_Updating  = ProvisioningState_STATUS("Updating")
)
View Source 
const (
	SignalRSkuTier_STATUS_Basic    = SignalRSkuTier_STATUS("Basic")
	SignalRSkuTier_STATUS_Free     = SignalRSkuTier_STATUS("Free")
	SignalRSkuTier_STATUS_Premium  = SignalRSkuTier_STATUS("Premium")
	SignalRSkuTier_STATUS_Standard = SignalRSkuTier_STATUS("Standard")
)
View Source 
const (
	SystemData_CreatedByType_STATUS_Application     = SystemData_CreatedByType_STATUS("Application")
	SystemData_CreatedByType_STATUS_Key             = SystemData_CreatedByType_STATUS("Key")
	SystemData_CreatedByType_STATUS_ManagedIdentity = SystemData_CreatedByType_STATUS("ManagedIdentity")
	SystemData_CreatedByType_STATUS_User            = SystemData_CreatedByType_STATUS("User")
)
View Source 
const (
	SystemData_LastModifiedByType_STATUS_Application     = SystemData_LastModifiedByType_STATUS("Application")
	SystemData_LastModifiedByType_STATUS_Key             = SystemData_LastModifiedByType_STATUS("Key")
	SystemData_LastModifiedByType_STATUS_ManagedIdentity = SystemData_LastModifiedByType_STATUS("ManagedIdentity")
	SystemData_LastModifiedByType_STATUS_User            = SystemData_LastModifiedByType_STATUS("User")
)
View Source 
const (
	ACLAction_STATUS_Allow = ACLAction_STATUS("Allow")
	ACLAction_STATUS_Deny  = ACLAction_STATUS("Deny")
)
View Source 
const (
	FeatureFlags_STATUS_EnableConnectivityLogs = FeatureFlags_STATUS("EnableConnectivityLogs")
	FeatureFlags_STATUS_EnableLiveTrace        = FeatureFlags_STATUS("EnableLiveTrace")
	FeatureFlags_STATUS_EnableMessagingLogs    = FeatureFlags_STATUS("EnableMessagingLogs")
	FeatureFlags_STATUS_ServiceMode            = FeatureFlags_STATUS("ServiceMode")
)
View Source 
const (
	SignalRRequestType_STATUS_ClientConnection = SignalRRequestType_STATUS("ClientConnection")
	SignalRRequestType_STATUS_RESTAPI          = SignalRRequestType_STATUS("RESTAPI")
	SignalRRequestType_STATUS_ServerConnection = SignalRRequestType_STATUS("ServerConnection")
	SignalRRequestType_STATUS_Trace            = SignalRRequestType_STATUS("Trace")
)
View Source 
const (
	UpstreamAuthType_STATUS_ManagedIdentity = UpstreamAuthType_STATUS("ManagedIdentity")
	UpstreamAuthType_STATUS_None            = UpstreamAuthType_STATUS("None")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ACLAction 

type ACLAction string

Azure Networking ACL Action. +kubebuilder:validation:Enum={"Allow","Deny"}

type ACLAction_STATUS 

type ACLAction_STATUS string

Azure Networking ACL Action.

type FeatureFlags 

type FeatureFlags string

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. - EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. - EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. +kubebuilder:validation:Enum={"EnableConnectivityLogs","EnableLiveTrace","EnableMessagingLogs","ServiceMode"}

type FeatureFlags_STATUS 

type FeatureFlags_STATUS string

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. - EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. - EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature.

type ManagedIdentity 

type ManagedIdentity struct {
	// Type: Represents the identity type: systemAssigned, userAssigned, None
	Type                   *ManagedIdentityType                   `json:"type,omitempty"`
	UserAssignedIdentities map[string]UserAssignedIdentityDetails `json:"userAssignedIdentities,omitempty"`
}

A class represent managed identities used for request and response

type ManagedIdentitySettings 

type ManagedIdentitySettings struct {
	// Resource: The Resource indicating the App ID URI of the target resource.
	// It also appears in the aud (audience) claim of the issued token.
	Resource *string `json:"resource,omitempty"`
}

Managed identity settings for upstream.

type ManagedIdentitySettings_STATUS 

type ManagedIdentitySettings_STATUS struct {
	// Resource: The Resource indicating the App ID URI of the target resource.
	// It also appears in the aud (audience) claim of the issued token.
	Resource *string `json:"resource,omitempty"`
}

Managed identity settings for upstream.

type ManagedIdentityType 

type ManagedIdentityType string

Represents the identity type: systemAssigned, userAssigned, None +kubebuilder:validation:Enum={"None","SystemAssigned","UserAssigned"}

type ManagedIdentityType_STATUS 

type ManagedIdentityType_STATUS string

Represents the identity type: systemAssigned, userAssigned, None

type ManagedIdentity_STATUS 

type ManagedIdentity_STATUS struct {
	// PrincipalId: Get the principal id for the system assigned identity.
	// Only be used in response.
	PrincipalId *string `json:"principalId,omitempty"`

	// TenantId: Get the tenant id for the system assigned identity.
	// Only be used in response
	TenantId *string `json:"tenantId,omitempty"`

	// Type: Represents the identity type: systemAssigned, userAssigned, None
	Type *ManagedIdentityType_STATUS `json:"type,omitempty"`

	// UserAssignedIdentities: Get or set the user assigned identities
	UserAssignedIdentities map[string]UserAssignedIdentityProperty_STATUS `json:"userAssignedIdentities,omitempty"`
}

A class represent managed identities used for request and response

type NetworkACL 

type NetworkACL struct {
	// Allow: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
	Allow []SignalRRequestType `json:"allow,omitempty"`

	// Deny: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
	Deny []SignalRRequestType `json:"deny,omitempty"`
}

Network ACL

type NetworkACL_STATUS 

type NetworkACL_STATUS struct {
	// Allow: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
	Allow []SignalRRequestType_STATUS `json:"allow,omitempty"`

	// Deny: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
	Deny []SignalRRequestType_STATUS `json:"deny,omitempty"`
}

Network ACL

type PrivateEndpointACL 

type PrivateEndpointACL struct {
	// Allow: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
	Allow []SignalRRequestType `json:"allow,omitempty"`

	// Deny: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
	Deny []SignalRRequestType `json:"deny,omitempty"`

	// Name: Name of the private endpoint connection
	Name *string `json:"name,omitempty"`
}

ACL for a private endpoint

type PrivateEndpointACL_STATUS 

type PrivateEndpointACL_STATUS struct {
	// Allow: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
	Allow []SignalRRequestType_STATUS `json:"allow,omitempty"`

	// Deny: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
	Deny []SignalRRequestType_STATUS `json:"deny,omitempty"`

	// Name: Name of the private endpoint connection
	Name *string `json:"name,omitempty"`
}

ACL for a private endpoint

type PrivateEndpointConnection_STATUS_SignalR_SubResourceEmbedded 

type PrivateEndpointConnection_STATUS_SignalR_SubResourceEmbedded struct {
	// Id: Fully qualified resource Id for the resource.
	Id *string `json:"id,omitempty"`
}

A private endpoint connection to an azure resource

type ProvisioningState_STATUS 

type ProvisioningState_STATUS string

Provisioning state of the resource.

type ResourceLogCategory 

type ResourceLogCategory struct {
	// Enabled: Indicates whether or the resource log category is enabled.
	// Available values: true, false.
	// Case insensitive.
	Enabled *string `json:"enabled,omitempty"`

	// Name: Gets or sets the resource log category's name.
	// Available values: ConnectivityLogs, MessagingLogs.
	// Case insensitive.
	Name *string `json:"name,omitempty"`
}

Resource log category configuration of a Microsoft.SignalRService resource.

type ResourceLogCategory_STATUS 

type ResourceLogCategory_STATUS struct {
	// Enabled: Indicates whether or the resource log category is enabled.
	// Available values: true, false.
	// Case insensitive.
	Enabled *string `json:"enabled,omitempty"`

	// Name: Gets or sets the resource log category's name.
	// Available values: ConnectivityLogs, MessagingLogs.
	// Case insensitive.
	Name *string `json:"name,omitempty"`
}

Resource log category configuration of a Microsoft.SignalRService resource.

type ResourceLogConfiguration 

type ResourceLogConfiguration struct {
	// Categories: Gets or sets the list of category configurations.
	Categories []ResourceLogCategory `json:"categories,omitempty"`
}

Resource log configuration of a Microsoft.SignalRService resource.

type ResourceLogConfiguration_STATUS 

type ResourceLogConfiguration_STATUS struct {
	// Categories: Gets or sets the list of category configurations.
	Categories []ResourceLogCategory_STATUS `json:"categories,omitempty"`
}

Resource log configuration of a Microsoft.SignalRService resource.

type ResourceSku 

type ResourceSku struct {
	// Capacity: Optional, integer. The unit count of the resource. 1 by default.
	// If present, following values are allowed:
	// Free: 1
	// Standard: 1,2,5,10,20,50,100
	Capacity *int `json:"capacity,omitempty"`

	// Name: The name of the SKU. Required.
	// Allowed values: Standard_S1, Free_F1
	Name *string `json:"name,omitempty"`

	// Tier: Optional tier of this particular SKU. 'Standard' or 'Free'.
	// `Basic` is deprecated, use `Standard` instead.
	Tier *SignalRSkuTier `json:"tier,omitempty"`
}

The billing information of the resource.

type ResourceSku_STATUS 

type ResourceSku_STATUS struct {
	// Capacity: Optional, integer. The unit count of the resource. 1 by default.
	// If present, following values are allowed:
	// Free: 1
	// Standard: 1,2,5,10,20,50,100
	Capacity *int `json:"capacity,omitempty"`

	// Family: Not used. Retained for future use.
	Family *string `json:"family,omitempty"`

	// Name: The name of the SKU. Required.
	// Allowed values: Standard_S1, Free_F1
	Name *string `json:"name,omitempty"`

	// Size: Not used. Retained for future use.
	Size *string `json:"size,omitempty"`

	// Tier: Optional tier of this particular SKU. 'Standard' or 'Free'.
	// `Basic` is deprecated, use `Standard` instead.
	Tier *SignalRSkuTier_STATUS `json:"tier,omitempty"`
}

The billing information of the resource.

type ServerlessUpstreamSettings 

type ServerlessUpstreamSettings struct {
	// Templates: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.
	Templates []UpstreamTemplate `json:"templates,omitempty"`
}

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

type ServerlessUpstreamSettings_STATUS 

type ServerlessUpstreamSettings_STATUS struct {
	// Templates: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.
	Templates []UpstreamTemplate_STATUS `json:"templates,omitempty"`
}

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

type ServiceKind 

type ServiceKind string

The kind of the service, it can be SignalR or RawWebSockets +kubebuilder:validation:Enum={"RawWebSockets","SignalR"}

type ServiceKind_STATUS 

type ServiceKind_STATUS string

The kind of the service, it can be SignalR or RawWebSockets

type SharedPrivateLinkResource_STATUS_SignalR_SubResourceEmbedded 

type SharedPrivateLinkResource_STATUS_SignalR_SubResourceEmbedded struct {
	// Id: Fully qualified resource Id for the resource.
	Id *string `json:"id,omitempty"`
}

Describes a Shared Private Link Resource

type SignalRCorsSettings 

type SignalRCorsSettings struct {
	// AllowedOrigins: 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.
	AllowedOrigins []string `json:"allowedOrigins,omitempty"`
}

Cross-Origin Resource Sharing (CORS) settings.

type SignalRCorsSettings_STATUS 

type SignalRCorsSettings_STATUS struct {
	// AllowedOrigins: 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.
	AllowedOrigins []string `json:"allowedOrigins,omitempty"`
}

Cross-Origin Resource Sharing (CORS) settings.

type SignalRFeature 

type SignalRFeature struct {
	// Flag: 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.
	// - EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category  respectively.
	// - EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will  give you live
	// traces in real time, it will be helpful when you developing your own Azure SignalR based web application  or
	// self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged.
	// Values allowed: "true"/"false", to enable/disable live trace feature.
	Flag *FeatureFlags `json:"flag,omitempty"`

	// Properties: Optional properties related to this feature.
	Properties map[string]string `json:"properties,omitempty"`

	// Value: Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for
	// allowed values.
	Value *string `json:"value,omitempty"`
}

Feature of a resource, which controls the runtime behavior.

type SignalRFeature_STATUS 

type SignalRFeature_STATUS struct {
	// Flag: 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.
	// - EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category  respectively.
	// - EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will  give you live
	// traces in real time, it will be helpful when you developing your own Azure SignalR based web application  or
	// self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged.
	// Values allowed: "true"/"false", to enable/disable live trace feature.
	Flag *FeatureFlags_STATUS `json:"flag,omitempty"`

	// Properties: Optional properties related to this feature.
	Properties map[string]string `json:"properties,omitempty"`

	// Value: Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for
	// allowed values.
	Value *string `json:"value,omitempty"`
}

Feature of a resource, which controls the runtime behavior.

type SignalRNetworkACLs 

type SignalRNetworkACLs struct {
	// DefaultAction: Azure Networking ACL Action.
	DefaultAction *ACLAction `json:"defaultAction,omitempty"`

	// PrivateEndpoints: ACLs for requests from private endpoints
	PrivateEndpoints []PrivateEndpointACL `json:"privateEndpoints,omitempty"`

	// PublicNetwork: Network ACL
	PublicNetwork *NetworkACL `json:"publicNetwork,omitempty"`
}

Network ACLs for the resource

type SignalRNetworkACLs_STATUS 

type SignalRNetworkACLs_STATUS struct {
	// DefaultAction: Azure Networking ACL Action.
	DefaultAction *ACLAction_STATUS `json:"defaultAction,omitempty"`

	// PrivateEndpoints: ACLs for requests from private endpoints
	PrivateEndpoints []PrivateEndpointACL_STATUS `json:"privateEndpoints,omitempty"`

	// PublicNetwork: Network ACL
	PublicNetwork *NetworkACL_STATUS `json:"publicNetwork,omitempty"`
}

Network ACLs for the resource

type SignalRProperties 

type SignalRProperties struct {
	// Cors: Cross-Origin Resource Sharing (CORS) settings.
	Cors *SignalRCorsSettings `json:"cors,omitempty"`

	// DisableAadAuth: DisableLocalAuth
	// Enable or disable aad auth
	// When set as true, connection with AuthType=aad won't work.
	DisableAadAuth *bool `json:"disableAadAuth,omitempty"`

	// DisableLocalAuth: DisableLocalAuth
	// Enable or disable local auth with AccessKey
	// When set as true, connection with AccessKey=xxx won't work.
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`

	// 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.
	Features []SignalRFeature `json:"features,omitempty"`

	// NetworkACLs: Network ACLs for the resource
	NetworkACLs *SignalRNetworkACLs `json:"networkACLs,omitempty"`

	// 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.
	PublicNetworkAccess *string `json:"publicNetworkAccess,omitempty"`

	// ResourceLogConfiguration: Resource log configuration of a Microsoft.SignalRService resource.
	ResourceLogConfiguration *ResourceLogConfiguration `json:"resourceLogConfiguration,omitempty"`

	// Tls: TLS settings for the resource
	Tls *SignalRTlsSettings `json:"tls,omitempty"`

	// Upstream: The settings for the Upstream when the service is in server-less mode.
	Upstream *ServerlessUpstreamSettings `json:"upstream,omitempty"`
}

A class that describes the properties of the resource

type SignalRProperties_STATUS 

type SignalRProperties_STATUS struct {
	// Cors: Cross-Origin Resource Sharing (CORS) settings.
	Cors *SignalRCorsSettings_STATUS `json:"cors,omitempty"`

	// DisableAadAuth: DisableLocalAuth
	// Enable or disable aad auth
	// When set as true, connection with AuthType=aad won't work.
	DisableAadAuth *bool `json:"disableAadAuth,omitempty"`

	// DisableLocalAuth: DisableLocalAuth
	// Enable or disable local auth with AccessKey
	// When set as true, connection with AccessKey=xxx won't work.
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`

	// ExternalIP: The publicly accessible IP of the resource.
	ExternalIP *string `json:"externalIP,omitempty"`

	// 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.
	Features []SignalRFeature_STATUS `json:"features,omitempty"`

	// HostName: FQDN of the service instance.
	HostName *string `json:"hostName,omitempty"`

	// HostNamePrefix: Deprecated.
	HostNamePrefix *string `json:"hostNamePrefix,omitempty"`

	// NetworkACLs: Network ACLs for the resource
	NetworkACLs *SignalRNetworkACLs_STATUS `json:"networkACLs,omitempty"`

	// PrivateEndpointConnections: Private endpoint connections to the resource.
	PrivateEndpointConnections []PrivateEndpointConnection_STATUS_SignalR_SubResourceEmbedded `json:"privateEndpointConnections,omitempty"`

	// ProvisioningState: Provisioning state of the resource.
	ProvisioningState *ProvisioningState_STATUS `json:"provisioningState,omitempty"`

	// 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.
	PublicNetworkAccess *string `json:"publicNetworkAccess,omitempty"`

	// PublicPort: The publicly accessible port of the resource which is designed for browser/client side usage.
	PublicPort *int `json:"publicPort,omitempty"`

	// ResourceLogConfiguration: Resource log configuration of a Microsoft.SignalRService resource.
	ResourceLogConfiguration *ResourceLogConfiguration_STATUS `json:"resourceLogConfiguration,omitempty"`

	// ServerPort: The publicly accessible port of the resource which is designed for customer server side usage.
	ServerPort *int `json:"serverPort,omitempty"`

	// SharedPrivateLinkResources: The list of shared private link resources.
	SharedPrivateLinkResources []SharedPrivateLinkResource_STATUS_SignalR_SubResourceEmbedded `json:"sharedPrivateLinkResources,omitempty"`

	// Tls: TLS settings for the resource
	Tls *SignalRTlsSettings_STATUS `json:"tls,omitempty"`

	// Upstream: The settings for the Upstream when the service is in server-less mode.
	Upstream *ServerlessUpstreamSettings_STATUS `json:"upstream,omitempty"`

	// Version: Version of the resource. Probably you need the same or higher version of client SDKs.
	Version *string `json:"version,omitempty"`
}

A class that describes the properties of the resource

type SignalRRequestType 

type SignalRRequestType string

The incoming request type to the service +kubebuilder:validation:Enum={"ClientConnection","RESTAPI","ServerConnection","Trace"}

type SignalRRequestType_STATUS 

type SignalRRequestType_STATUS string

The incoming request type to the service

type SignalRSkuTier 

type SignalRSkuTier string

Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead. +kubebuilder:validation:Enum={"Basic","Free","Premium","Standard"}

type SignalRSkuTier_STATUS 

type SignalRSkuTier_STATUS string

Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead.

type SignalRTlsSettings 

type SignalRTlsSettings struct {
	// ClientCertEnabled: Request client certificate during TLS handshake if enabled
	ClientCertEnabled *bool `json:"clientCertEnabled,omitempty"`
}

TLS settings for the resource

type SignalRTlsSettings_STATUS 

type SignalRTlsSettings_STATUS struct {
	// ClientCertEnabled: Request client certificate during TLS handshake if enabled
	ClientCertEnabled *bool `json:"clientCertEnabled,omitempty"`
}

TLS settings for the resource

type SignalR_STATUS 

type SignalR_STATUS struct {
	// Id: Fully qualified resource Id for the resource.
	Id *string `json:"id,omitempty"`

	// Identity: A class represent managed identities used for request and response
	Identity *ManagedIdentity_STATUS `json:"identity,omitempty"`

	// Kind: The kind of the service, it can be SignalR or RawWebSockets
	Kind *ServiceKind_STATUS `json:"kind,omitempty"`

	// Location: The GEO location of the resource. e.g. West US | East US | North Central US | South Central US.
	Location *string `json:"location,omitempty"`

	// Name: The name of the resource.
	Name *string `json:"name,omitempty"`

	// Properties: A class that describes the properties of the resource
	Properties *SignalRProperties_STATUS `json:"properties,omitempty"`

	// Sku: The billing information of the resource.
	Sku *ResourceSku_STATUS `json:"sku,omitempty"`

	// SystemData: Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData_STATUS `json:"systemData,omitempty"`

	// Tags: Tags of the service which is a list of key value pairs that describe the resource.
	Tags map[string]string `json:"tags,omitempty"`

	// Type: The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
	Type *string `json:"type,omitempty"`
}

type SignalR_Spec 

type SignalR_Spec struct {
	// Identity: A class represent managed identities used for request and response
	Identity *ManagedIdentity `json:"identity,omitempty"`

	// Kind: The kind of the service, it can be SignalR or RawWebSockets
	Kind *ServiceKind `json:"kind,omitempty"`

	// Location: The GEO location of the resource. e.g. West US | East US | North Central US | South Central US.
	Location *string `json:"location,omitempty"`
	Name     string  `json:"name,omitempty"`

	// Properties: A class that describes the properties of the resource
	Properties *SignalRProperties `json:"properties,omitempty"`

	// Sku: The billing information of the resource.
	Sku *ResourceSku `json:"sku,omitempty"`

	// Tags: Tags of the service which is a list of key value pairs that describe the resource.
	Tags map[string]string `json:"tags,omitempty"`
}

func (SignalR_Spec) GetAPIVersion 

func (signalR SignalR_Spec) GetAPIVersion() string

GetAPIVersion returns the ARM API version of the resource. This is always "2021-10-01"

func (*SignalR_Spec) GetName 

func (signalR *SignalR_Spec) GetName() string

GetName returns the Name of the resource

func (*SignalR_Spec) GetType 

func (signalR *SignalR_Spec) GetType() string

GetType returns the ARM Type of the resource. This is always "Microsoft.SignalRService/signalR"

type SystemData_CreatedByType_STATUS 

type SystemData_CreatedByType_STATUS string

type SystemData_LastModifiedByType_STATUS 

type SystemData_LastModifiedByType_STATUS string

type SystemData_STATUS 

type SystemData_STATUS struct {
	// CreatedAt: The timestamp of resource creation (UTC).
	CreatedAt *string `json:"createdAt,omitempty"`

	// CreatedBy: The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// CreatedByType: The type of identity that created the resource.
	CreatedByType *SystemData_CreatedByType_STATUS `json:"createdByType,omitempty"`

	// LastModifiedAt: The timestamp of resource last modification (UTC)
	LastModifiedAt *string `json:"lastModifiedAt,omitempty"`

	// LastModifiedBy: The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// LastModifiedByType: The type of identity that last modified the resource.
	LastModifiedByType *SystemData_LastModifiedByType_STATUS `json:"lastModifiedByType,omitempty"`
}

Metadata pertaining to creation and last modification of the resource.

type UpstreamAuthSettings 

type UpstreamAuthSettings struct {
	// ManagedIdentity: Managed identity settings for upstream.
	ManagedIdentity *ManagedIdentitySettings `json:"managedIdentity,omitempty"`

	// Type: Upstream auth type enum.
	Type *UpstreamAuthType `json:"type,omitempty"`
}

Upstream auth settings. If not set, no auth is used for upstream messages.

type UpstreamAuthSettings_STATUS 

type UpstreamAuthSettings_STATUS struct {
	// ManagedIdentity: Managed identity settings for upstream.
	ManagedIdentity *ManagedIdentitySettings_STATUS `json:"managedIdentity,omitempty"`

	// Type: Upstream auth type enum.
	Type *UpstreamAuthType_STATUS `json:"type,omitempty"`
}

Upstream auth settings. If not set, no auth is used for upstream messages.

type UpstreamAuthType 

type UpstreamAuthType string

Upstream auth type enum. +kubebuilder:validation:Enum={"ManagedIdentity","None"}

type UpstreamAuthType_STATUS 

type UpstreamAuthType_STATUS string

Upstream auth type enum.

type UpstreamTemplate 

type UpstreamTemplate struct {
	// Auth: Upstream auth settings. If not set, no auth is used for upstream messages.
	Auth *UpstreamAuthSettings `json:"auth,omitempty"`

	// CategoryPattern: 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"
	CategoryPattern *string `json:"categoryPattern,omitempty"`

	// EventPattern: 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"
	EventPattern *string `json:"eventPattern,omitempty"`

	// HubPattern: 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"
	HubPattern *string `json:"hubPattern,omitempty"`

	// UrlTemplate: 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`.
	UrlTemplate *string `json:"urlTemplate,omitempty"`
}

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.

type UpstreamTemplate_STATUS 

type UpstreamTemplate_STATUS struct {
	// Auth: Upstream auth settings. If not set, no auth is used for upstream messages.
	Auth *UpstreamAuthSettings_STATUS `json:"auth,omitempty"`

	// CategoryPattern: 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"
	CategoryPattern *string `json:"categoryPattern,omitempty"`

	// EventPattern: 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"
	EventPattern *string `json:"eventPattern,omitempty"`

	// HubPattern: 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"
	HubPattern *string `json:"hubPattern,omitempty"`

	// UrlTemplate: 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`.
	UrlTemplate *string `json:"urlTemplate,omitempty"`
}

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.

type UserAssignedIdentityDetails 

type UserAssignedIdentityDetails struct {
}

Information about the user assigned identity for the resource

type UserAssignedIdentityProperty_STATUS 

type UserAssignedIdentityProperty_STATUS struct {
	// ClientId: Get the client id for the user assigned identity
	ClientId *string `json:"clientId,omitempty"`

	// PrincipalId: Get the principal id for the user assigned identity
	PrincipalId *string `json:"principalId,omitempty"`
}

Properties of user assigned identity.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.