class Azure::Signalr::Mgmt::V2020_05_01::Models::SignalRResource

A class represent a SignalR service resource.

Attributes

cors[RW]

@return [SignalRCorsSettings] Cross-Origin Resource Sharing (CORS) settings.

external_ip[RW]

@return [String] The publicly accessible IP of the SignalR service.

features[RW]

@return [Array<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.

host_name[RW]

@return [String] FQDN of the SignalR service instance. Format: xxx.service.signalr.net

host_name_prefix[RW]

@return [String] Prefix for the hostName of the SignalR service. Retained for future use. The hostname will be of format: &lt;hostNamePrefix&gt;.service.signalr.net.

kind[RW]

@return [ServiceKind] The kind of the service - e.g. “SignalR”, or “RawWebSockets” for “Microsoft.SignalRService/SignalR”. Possible values include: 'SignalR', 'RawWebSockets'

network_acls[RW]

@return [SignalRNetworkACLs] Network ACLs

private_endpoint_connections[RW]

@return [Array<PrivateEndpointConnection>] Private endpoint connections to the SignalR resource.

provisioning_state[RW]

@return [ProvisioningState] Provisioning state of the resource. Possible values include: 'Unknown', 'Succeeded', 'Failed', 'Canceled', 'Running', 'Creating', 'Updating', 'Deleting', 'Moving'

public_port[RW]

@return [Integer] The publicly accessible port of the SignalR service which is designed for browser/client side usage.

server_port[RW]

@return [Integer] The publicly accessible port of the SignalR service which is designed for customer server side usage.

sku[RW]

@return [ResourceSku] The billing information of the resource.(e.g. Free, Standard)

upstream[RW]

@return [ServerlessUpstreamSettings] Upstream settings when the Azure SignalR is in server-less mode.

version[RW]

@return [String] Version of the SignalR resource. Probably you need the same or higher version of client SDKs.

Private Class Methods

mapper() click to toggle source

Mapper for SignalRResource class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/2020-05-01/generated/azure_mgmt_signalr/models/signal_rresource.rb, line 87
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'SignalRResource',
    type: {
      name: 'Composite',
      class_name: 'SignalRResource',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        location: {
          client_side_validation: true,
          required: false,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        sku: {
          client_side_validation: true,
          required: false,
          serialized_name: 'sku',
          type: {
            name: 'Composite',
            class_name: 'ResourceSku'
          }
        },
        host_name_prefix: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.hostNamePrefix',
          type: {
            name: 'String'
          }
        },
        features: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.features',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'SignalRFeatureElementType',
                type: {
                  name: 'Composite',
                  class_name: 'SignalRFeature'
                }
            }
          }
        },
        cors: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.cors',
          type: {
            name: 'Composite',
            class_name: 'SignalRCorsSettings'
          }
        },
        upstream: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.upstream',
          type: {
            name: 'Composite',
            class_name: 'ServerlessUpstreamSettings'
          }
        },
        network_acls: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.networkACLs',
          type: {
            name: 'Composite',
            class_name: 'SignalRNetworkACLs'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        external_ip: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.externalIP',
          type: {
            name: 'String'
          }
        },
        host_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.hostName',
          type: {
            name: 'String'
          }
        },
        public_port: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.publicPort',
          type: {
            name: 'Number'
          }
        },
        server_port: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.serverPort',
          type: {
            name: 'Number'
          }
        },
        version: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.version',
          type: {
            name: 'String'
          }
        },
        private_endpoint_connections: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.privateEndpointConnections',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'PrivateEndpointConnectionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'PrivateEndpointConnection'
                }
            }
          }
        },
        kind: {
          client_side_validation: true,
          required: false,
          serialized_name: 'kind',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end