Class: Azure::Signalr::Mgmt::V2018_10_01::Models::SignalRResource

Inherits:
TrackedResource show all
Includes:
MsRestAzure
Defined in:
lib/2018-10-01/generated/azure_mgmt_signalr/models/signal_rresource.rb

Overview

A class represent a SignalR service resource.

Instance Attribute Summary collapse

Attributes inherited from TrackedResource

#location, #tags

Attributes inherited from Resource

#id, #name, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#cors ⇒ SignalRCorsSettings

settings.

Returns:



39
40
41
 
# File 'lib/2018-10-01/generated/azure_mgmt_signalr/models/signal_rresource.rb', line 39

def cors
  @cors
end

#external_ip ⇒ String

Returns The publicly accessible IP of the SignalR service.

Returns:

  • (String) —

    The publicly accessible IP of the SignalR service.



47
48
49
 
# File 'lib/2018-10-01/generated/azure_mgmt_signalr/models/signal_rresource.rb', line 47

def external_ip
  @external_ip
end

#features ⇒ Array<SignalRFeature>

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.

Returns:



35
36
37
 
# File 'lib/2018-10-01/generated/azure_mgmt_signalr/models/signal_rresource.rb', line 35

def features
  @features
end

#host_name ⇒ String

xxx.service.signalr.net

Returns:

  • (String) —

    FQDN of the SignalR service instance. Format:



51
52
53
 
# File 'lib/2018-10-01/generated/azure_mgmt_signalr/models/signal_rresource.rb', line 51

def host_name
  @host_name
end

#host_name_prefix ⇒ String

Retained for future use. The hostname will be of format: &lt;hostNamePrefix&gt;.service.signalr.net.

Returns:

  • (String) —

    Prefix for the hostName of the SignalR service.



22
23
24
 
# File 'lib/2018-10-01/generated/azure_mgmt_signalr/models/signal_rresource.rb', line 22

def host_name_prefix
  @host_name_prefix
end

#provisioning_state ⇒ ProvisioningState

Possible values include: ‘Unknown’, ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘Running’, ‘Creating’, ‘Updating’, ‘Deleting’, ‘Moving’

Returns:



44
45
46
 
# File 'lib/2018-10-01/generated/azure_mgmt_signalr/models/signal_rresource.rb', line 44

def provisioning_state
  @provisioning_state
end

#public_port ⇒ Integer

which is designed for browser/client side usage.

Returns:

  • (Integer) —

    The publicly accessible port of the SignalR service



55
56
57
 
# File 'lib/2018-10-01/generated/azure_mgmt_signalr/models/signal_rresource.rb', line 55

def public_port
  @public_port
end

#server_port ⇒ Integer

which is designed for customer server side usage.

Returns:

  • (Integer) —

    The publicly accessible port of the SignalR service



59
60
61
 
# File 'lib/2018-10-01/generated/azure_mgmt_signalr/models/signal_rresource.rb', line 59

def server_port
  @server_port
end

#sku ⇒ ResourceSku

Returns SKU of the service.

Returns:



16
17
18
 
# File 'lib/2018-10-01/generated/azure_mgmt_signalr/models/signal_rresource.rb', line 16

def sku
  @sku
end

#version ⇒ String

same or higher version of client SDKs.

Returns:

  • (String) —

    Version of the SignalR resource. Probably you need the



63
64
65
 
# File 'lib/2018-10-01/generated/azure_mgmt_signalr/models/signal_rresource.rb', line 63

def version
  @version
end

Class Method Details

.mapper ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/2018-10-01/generated/azure_mgmt_signalr/models/signal_rresource.rb', line 70

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'
          }
        },
        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,
          serialized_name: 'properties.version',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end