Class: Azure::ARM::Web::Models::Domain

Inherits:
MsRestAzure::Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/generated/azure_mgmt_web/models/domain.rb

Overview

Represents a domain

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#auto_renew ⇒ Boolean

Returns If true then domain will renewed automatically.

Returns:

  • (Boolean) —

    If true then domain will renewed automatically



56
57
58
 
# File 'lib/generated/azure_mgmt_web/models/domain.rb', line 56

def auto_renew
  @auto_renew
end

#consent ⇒ DomainPurchaseConsent

Returns Legal agreement consent.

Returns:



68
69
70
 
# File 'lib/generated/azure_mgmt_web/models/domain.rb', line 68

def consent
  @consent
end

#contact_admin ⇒ Contact

Returns Admin contact information.

Returns:

  • (Contact) —

    Admin contact information



16
17
18
 
# File 'lib/generated/azure_mgmt_web/models/domain.rb', line 16

def contact_admin
  @contact_admin
end

#contact_billing ⇒ Contact

Returns Billing contact information.

Returns:

  • (Contact) —

    Billing contact information



19
20
21
 
# File 'lib/generated/azure_mgmt_web/models/domain.rb', line 19

def contact_billing
  @contact_billing
end

#contact_registrant ⇒ Contact

Returns Registrant contact information.

Returns:

  • (Contact) —

    Registrant contact information



22
23
24
 
# File 'lib/generated/azure_mgmt_web/models/domain.rb', line 22

def contact_registrant
  @contact_registrant
end

#contact_tech ⇒ Contact

Returns Technical contact information.

Returns:

  • (Contact) —

    Technical contact information



25
26
27
 
# File 'lib/generated/azure_mgmt_web/models/domain.rb', line 25

def contact_tech
  @contact_tech
end

#created_time ⇒ DateTime

Returns Domain creation timestamp.

Returns:

  • (DateTime) —

    Domain creation timestamp



47
48
49
 
# File 'lib/generated/azure_mgmt_web/models/domain.rb', line 47

def created_time
  @created_time
end

#domain_not_renewable_reasons ⇒ Object

Returns Reasons why domain is not renewable.

Returns:

  • Reasons why domain is not renewable



71
72
73
 
# File 'lib/generated/azure_mgmt_web/models/domain.rb', line 71

def domain_not_renewable_reasons
  @domain_not_renewable_reasons
end

#expiration_time ⇒ DateTime

Returns Domain expiration timestamp.

Returns:

  • (DateTime) —

    Domain expiration timestamp



50
51
52
 
# File 'lib/generated/azure_mgmt_web/models/domain.rb', line 50

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



53
54
55
 
# File 'lib/generated/azure_mgmt_web/models/domain.rb', line 53

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



65
66
67
 
# File 'lib/generated/azure_mgmt_web/models/domain.rb', line 65

def managed_host_names
  @managed_host_names
end

#name_servers ⇒ Array<String>

Returns Name servers.

Returns:

  • (Array<String>) —

    Name servers



40
41
42
 
# File 'lib/generated/azure_mgmt_web/models/domain.rb', line 40

def name_servers
  @name_servers
end

#privacy ⇒ Boolean

domain

Returns:

  • (Boolean) —

    If true then domain privacy is enabled for this



44
45
46
 
# File 'lib/generated/azure_mgmt_web/models/domain.rb', line 44

def privacy
  @privacy
end

#provisioning_state ⇒ ProvisioningState

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

Returns:



37
38
39
 
# File 'lib/generated/azure_mgmt_web/models/domain.rb', line 37

def provisioning_state
  @provisioning_state
end

#ready_for_dns_record_management ⇒ Boolean

Apps. 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) —

    If true then Azure can assign this domain to Web



61
62
63
 
# File 'lib/generated/azure_mgmt_web/models/domain.rb', line 61

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



33
34
35
 
# File 'lib/generated/azure_mgmt_web/models/domain.rb', line 33

def registration_status
  @registration_status
end

Class Method Details

.mapper ⇒ Object

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



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
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
 
# File 'lib/generated/azure_mgmt_web/models/domain.rb', line 78

def self.mapper()
  {
    required: false,
    serialized_name: 'Domain',
    type: {
      name: 'Composite',
      class_name: 'Domain',
      model_properties: {
        id: {
          required: false,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          required: false,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        kind: {
          required: false,
          serialized_name: 'kind',
          type: {
            name: 'String'
          }
        },
        location: {
          required: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        type: {
          required: false,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        tags: {
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        contact_admin: {
          required: false,
          serialized_name: 'properties.contactAdmin',
          type: {
            name: 'Composite',
            class_name: 'Contact'
          }
        },
        contact_billing: {
          required: false,
          serialized_name: 'properties.contactBilling',
          type: {
            name: 'Composite',
            class_name: 'Contact'
          }
        },
        contact_registrant: {
          required: false,
          serialized_name: 'properties.contactRegistrant',
          type: {
            name: 'Composite',
            class_name: 'Contact'
          }
        },
        contact_tech: {
          required: false,
          serialized_name: 'properties.contactTech',
          type: {
            name: 'Composite',
            class_name: 'Contact'
          }
        },
        registration_status: {
          required: false,
          serialized_name: 'properties.registrationStatus',
          type: {
            name: 'Enum',
            module: 'DomainStatus'
          }
        },
        provisioning_state: {
          required: false,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'Enum',
            module: 'ProvisioningState'
          }
        },
        name_servers: {
          required: false,
          serialized_name: 'properties.nameServers',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        privacy: {
          required: false,
          serialized_name: 'properties.privacy',
          type: {
            name: 'Boolean'
          }
        },
        created_time: {
          required: false,
          serialized_name: 'properties.createdTime',
          type: {
            name: 'DateTime'
          }
        },
        expiration_time: {
          required: false,
          serialized_name: 'properties.expirationTime',
          type: {
            name: 'DateTime'
          }
        },
        last_renewed_time: {
          required: false,
          serialized_name: 'properties.lastRenewedTime',
          type: {
            name: 'DateTime'
          }
        },
        auto_renew: {
          required: false,
          serialized_name: 'properties.autoRenew',
          type: {
            name: 'Boolean'
          }
        },
        ready_for_dns_record_management: {
          required: false,
          serialized_name: 'properties.readyForDnsRecordManagement',
          type: {
            name: 'Boolean'
          }
        },
        managed_host_names: {
          required: false,
          serialized_name: 'properties.managedHostNames',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'HostNameElementType',
                type: {
                  name: 'Composite',
                  class_name: 'HostName'
                }
            }
          }
        },
        consent: {
          required: false,
          serialized_name: 'properties.consent',
          type: {
            name: 'Composite',
            class_name: 'DomainPurchaseConsent'
          }
        },
        domain_not_renewable_reasons: {
          required: false,
          serialized_name: 'properties.domainNotRenewableReasons',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'ElementType',
                type: {
                  name: 'String'
                }
            }
          }
        }
      }
    }
  }
end