Class: Azure::Web::Mgmt::V2018_02_01::Models::DomainPatchResource

Inherits:
ProxyOnlyResource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb

Overview

ARM resource for a domain.

Instance Attribute Summary collapse

Attributes inherited from ProxyOnlyResource

#id, #kind, #name, #type

Class Method Summary collapse

Instance Attribute Details

#auth_code ⇒ String

Returns:

  • (String) 


87
88
89
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 87

def auth_code
  @auth_code
end

#auto_renew ⇒ Boolean

automatically renewed; otherwise, false. Default value: true .

Returns:

  • (Boolean) —

    true if the domain should be



57
58
59
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 57

def auto_renew
  @auto_renew
end

#consent ⇒ DomainPurchaseConsent

Returns Legal agreement consent.

Returns:



70
71
72
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 70

def consent
  @consent
end

#contact_admin ⇒ Contact

Returns Administrative contact.

Returns:

  • (Contact) —

    Administrative contact.



16
17
18
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 16

def contact_admin
  @contact_admin
end

#contact_billing ⇒ Contact

Returns Billing contact.

Returns:



19
20
21
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 19

def contact_billing
  @contact_billing
end

#contact_registrant ⇒ Contact

Returns Registrant contact.

Returns:

  • (Contact) —

    Registrant contact.



22
23
24
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 22

def contact_registrant
  @contact_registrant
end

#contact_tech ⇒ Contact

Returns Technical contact.

Returns:



25
26
27
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 25

def contact_tech
  @contact_tech
end

#created_time ⇒ DateTime

Returns Domain creation timestamp.

Returns:

  • (DateTime) —

    Domain creation timestamp.



46
47
48
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 46

def created_time
  @created_time
end

#dns_type ⇒ DnsType

‘AzureDns’, ‘DefaultDomainRegistrarDns’

Returns:

  • (DnsType) —

    Current DNS type. Possible values include:



77
78
79
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 77

def dns_type
  @dns_type
end

#dns_zone_id ⇒ String

Returns Azure DNS Zone to use.

Returns:

  • (String) —

    Azure DNS Zone to use



80
81
82
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 80

def dns_zone_id
  @dns_zone_id
end

#domain_not_renewable_reasons ⇒ Array<Enum>

Returns Reasons why domain is not renewable.

Returns:

  • (Array<Enum>) —

    Reasons why domain is not renewable.



73
74
75
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 73

def domain_not_renewable_reasons
  @domain_not_renewable_reasons
end

#expiration_time ⇒ DateTime

Returns Domain expiration timestamp.

Returns:

  • (DateTime) —

    Domain expiration timestamp.



49
50
51
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 49

def expiration_time
  @expiration_time
end

#last_renewed_time ⇒ DateTime

Returns Timestamp when the domain was renewed last time.

Returns:

  • (DateTime) —

    Timestamp when the domain was renewed last time.



52
53
54
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 52

def last_renewed_time
  @last_renewed_time
end

#managed_host_names ⇒ Array<HostName>

assigned to Azure resources.

Returns:

  • (Array<HostName>) —

    All hostnames derived from the domain and



67
68
69
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 67

def managed_host_names
  @managed_host_names
end

#name_servers ⇒ Array<String>

Returns Name servers.

Returns:

  • (Array<String>) —

    Name servers.



39
40
41
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 39

def name_servers
  @name_servers
end

#privacy ⇒ Boolean

this domain; otherwise, false.

Returns:

  • (Boolean) —

    true if domain privacy is enabled for



43
44
45
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 43

def privacy
  @privacy
end

#provisioning_state ⇒ ProvisioningState

include: ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘InProgress’, ‘Deleting’

Returns:



36
37
38
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 36

def provisioning_state
  @provisioning_state
end

#ready_for_dns_record_management ⇒ Boolean

App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to.

Returns:

  • (Boolean) —

    true if Azure can assign this domain to



63
64
65
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 63

def ready_for_dns_record_management
  @ready_for_dns_record_management
end

#registration_status ⇒ DomainStatus

include: ‘Active’, ‘Awaiting’, ‘Cancelled’, ‘Confiscated’, ‘Disabled’, ‘Excluded’, ‘Expired’, ‘Failed’, ‘Held’, ‘Locked’, ‘Parked’, ‘Pending’, ‘Reserved’, ‘Reverted’, ‘Suspended’, ‘Transferred’, ‘Unknown’, ‘Unlocked’, ‘Unparked’, ‘Updated’, ‘JsonConverterFailed’

Returns:

  • (DomainStatus) —

    Domain registration status. Possible values



32
33
34
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 32

def registration_status
  @registration_status
end

#target_dns_type ⇒ DnsType

Possible values include: ‘AzureDns’, ‘DefaultDomainRegistrarDns’

Returns:

  • (DnsType) —

    Target DNS type (would be used for migration).



84
85
86
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 84

def target_dns_type
  @target_dns_type
end

Class Method Details

.mapper ⇒ Object

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



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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/domain_patch_resource.rb', line 94

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'DomainPatchResource',
    type: {
      name: 'Composite',
      class_name: 'DomainPatchResource',
      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'
          }
        },
        kind: {
          client_side_validation: true,
          required: false,
          serialized_name: 'kind',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        contact_admin: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.contactAdmin',
          type: {
            name: 'Composite',
            class_name: 'Contact'
          }
        },
        contact_billing: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.contactBilling',
          type: {
            name: 'Composite',
            class_name: 'Contact'
          }
        },
        contact_registrant: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.contactRegistrant',
          type: {
            name: 'Composite',
            class_name: 'Contact'
          }
        },
        contact_tech: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.contactTech',
          type: {
            name: 'Composite',
            class_name: 'Contact'
          }
        },
        registration_status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.registrationStatus',
          type: {
            name: 'Enum',
            module: 'DomainStatus'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'Enum',
            module: 'ProvisioningState'
          }
        },
        name_servers: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.nameServers',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        privacy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.privacy',
          type: {
            name: 'Boolean'
          }
        },
        created_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.createdTime',
          type: {
            name: 'DateTime'
          }
        },
        expiration_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.expirationTime',
          type: {
            name: 'DateTime'
          }
        },
        last_renewed_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.lastRenewedTime',
          type: {
            name: 'DateTime'
          }
        },
        auto_renew: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.autoRenew',
          default_value: true,
          type: {
            name: 'Boolean'
          }
        },
        ready_for_dns_record_management: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.readyForDnsRecordManagement',
          type: {
            name: 'Boolean'
          }
        },
        managed_host_names: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.managedHostNames',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'HostNameElementType',
                type: {
                  name: 'Composite',
                  class_name: 'HostName'
                }
            }
          }
        },
        consent: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.consent',
          type: {
            name: 'Composite',
            class_name: 'DomainPurchaseConsent'
          }
        },
        domain_not_renewable_reasons: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.domainNotRenewableReasons',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'enumElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        dns_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.dnsType',
          type: {
            name: 'Enum',
            module: 'DnsType'
          }
        },
        dns_zone_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.dnsZoneId',
          type: {
            name: 'String'
          }
        },
        target_dns_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.targetDnsType',
          type: {
            name: 'Enum',
            module: 'DnsType'
          }
        },
        auth_code: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.authCode',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end