Class: MicrosoftGraph::Models::Domain

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/domain.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Entity

#additional_data, #additional_data=, #id, #id=, #odata_type, #odata_type=

Constructor Details

#initialize ⇒ Object

Instantiates a new domain and sets the default values.



94
95
96
 
# File 'lib/models/domain.rb', line 94

def initialize()
    super
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node —

    The parse node to use to read the discriminator value and create the object

Returns:

  • a domain

Raises:

  • (StandardError) 


102
103
104
105
 
# File 'lib/models/domain.rb', line 102

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return Domain.new
end

Instance Method Details

#authentication_type ⇒ Object

Gets the authenticationType property value. Indicates the configured authentication type for the domain. The value is either Managed or Federated. Managed indicates a cloud managed domain where Azure AD performs user authentication. Federated indicates authentication is federated with an identity provider such as the tenant’s on-premises Active Directory via Active Directory Federation Services. Not nullable.

Returns:

  • a string



64
65
66
 
# File 'lib/models/domain.rb', line 64

def authentication_type
    return @authentication_type
end

#authentication_type=(value) ⇒ Object

Sets the authenticationType property value. Indicates the configured authentication type for the domain. The value is either Managed or Federated. Managed indicates a cloud managed domain where Azure AD performs user authentication. Federated indicates authentication is federated with an identity provider such as the tenant’s on-premises Active Directory via Active Directory Federation Services. Not nullable.

Parameters:

  • value —

    Value to set for the authenticationType property.

Returns:

  • a void



72
73
74
 
# File 'lib/models/domain.rb', line 72

def authentication_type=(value)
    @authentication_type = value
end

#availability_status ⇒ Object

Gets the availabilityStatus property value. This property is always null except when the verify action is used. When the verify action is used, a domain entity is returned in the response. The availabilityStatus property of the domain entity in the response is either AvailableImmediately or EmailVerifiedDomainTakeoverScheduled.

Returns:

  • a string



79
80
81
 
# File 'lib/models/domain.rb', line 79

def availability_status
    return @availability_status
end

#availability_status=(value) ⇒ Object

Sets the availabilityStatus property value. This property is always null except when the verify action is used. When the verify action is used, a domain entity is returned in the response. The availabilityStatus property of the domain entity in the response is either AvailableImmediately or EmailVerifiedDomainTakeoverScheduled.

Parameters:

  • value —

    Value to set for the availabilityStatus property.

Returns:

  • a void



87
88
89
 
# File 'lib/models/domain.rb', line 87

def availability_status=(value)
    @availability_status = value
end

#domain_name_references ⇒ Object

Gets the domainNameReferences property value. The objects such as users and groups that reference the domain ID. Read-only, Nullable. Supports $expand and $filter by the OData type of objects returned. For example /domains/domainId/domainNameReferences/microsoft.graph.user and /domains/domainId/domainNameReferences/microsoft.graph.group.

Returns:

  • a directory_object



110
111
112
 
# File 'lib/models/domain.rb', line 110

def domain_name_references
    return @domain_name_references
end

#domain_name_references=(value) ⇒ Object

Sets the domainNameReferences property value. The objects such as users and groups that reference the domain ID. Read-only, Nullable. Supports $expand and $filter by the OData type of objects returned. For example /domains/domainId/domainNameReferences/microsoft.graph.user and /domains/domainId/domainNameReferences/microsoft.graph.group.

Parameters:

  • value —

    Value to set for the domainNameReferences property.

Returns:

  • a void



118
119
120
 
# File 'lib/models/domain.rb', line 118

def domain_name_references=(value)
    @domain_name_references = value
end

#federation_configuration ⇒ Object

Gets the federationConfiguration property value. Domain settings configured by a customer when federated with Azure AD. Supports $expand.

Returns:

  • a internal_domain_federation



125
126
127
 
# File 'lib/models/domain.rb', line 125

def federation_configuration
    return @federation_configuration
end

#federation_configuration=(value) ⇒ Object

Sets the federationConfiguration property value. Domain settings configured by a customer when federated with Azure AD. Supports $expand.

Parameters:

  • value —

    Value to set for the federationConfiguration property.

Returns:

  • a void



133
134
135
 
# File 'lib/models/domain.rb', line 133

def federation_configuration=(value)
    @federation_configuration = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/models/domain.rb', line 140

def get_field_deserializers()
    return super.merge({
        "authenticationType" => lambda {|n| @authentication_type = n.get_string_value() },
        "availabilityStatus" => lambda {|n| @availability_status = n.get_string_value() },
        "domainNameReferences" => lambda {|n| @domain_name_references = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "federationConfiguration" => lambda {|n| @federation_configuration = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::InternalDomainFederation.create_from_discriminator_value(pn) }) },
        "isAdminManaged" => lambda {|n| @is_admin_managed = n.get_boolean_value() },
        "isDefault" => lambda {|n| @is_default = n.get_boolean_value() },
        "isInitial" => lambda {|n| @is_initial = n.get_boolean_value() },
        "isRoot" => lambda {|n| @is_root = n.get_boolean_value() },
        "isVerified" => lambda {|n| @is_verified = n.get_boolean_value() },
        "manufacturer" => lambda {|n| @manufacturer = n.get_string_value() },
        "model" => lambda {|n| @model = n.get_string_value() },
        "passwordNotificationWindowInDays" => lambda {|n| @password_notification_window_in_days = n.get_number_value() },
        "passwordValidityPeriodInDays" => lambda {|n| @password_validity_period_in_days = n.get_number_value() },
        "serviceConfigurationRecords" => lambda {|n| @service_configuration_records = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DomainDnsRecord.create_from_discriminator_value(pn) }) },
        "state" => lambda {|n| @state = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::DomainState.create_from_discriminator_value(pn) }) },
        "supportedServices" => lambda {|n| @supported_services = n.get_collection_of_primitive_values(String) },
        "verificationDnsRecords" => lambda {|n| @verification_dns_records = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DomainDnsRecord.create_from_discriminator_value(pn) }) },
    })
end

#is_admin_managed ⇒ Object

Gets the isAdminManaged property value. The value of the property is false if the DNS record management of the domain has been delegated to Microsoft 365. Otherwise, the value is true. Not nullable

Returns:

  • a boolean



165
166
167
 
# File 'lib/models/domain.rb', line 165

def is_admin_managed
    return @is_admin_managed
end

#is_admin_managed=(value) ⇒ Object

Sets the isAdminManaged property value. The value of the property is false if the DNS record management of the domain has been delegated to Microsoft 365. Otherwise, the value is true. Not nullable

Parameters:

  • value —

    Value to set for the isAdminManaged property.

Returns:

  • a void



173
174
175
 
# File 'lib/models/domain.rb', line 173

def is_admin_managed=(value)
    @is_admin_managed = value
end

#is_default ⇒ Object

Gets the isDefault property value. true if this is the default domain that is used for user creation. There is only one default domain per company. Not nullable

Returns:

  • a boolean



180
181
182
 
# File 'lib/models/domain.rb', line 180

def is_default
    return @is_default
end

#is_default=(value) ⇒ Object

Sets the isDefault property value. true if this is the default domain that is used for user creation. There is only one default domain per company. Not nullable

Parameters:

  • value —

    Value to set for the isDefault property.

Returns:

  • a void



188
189
190
 
# File 'lib/models/domain.rb', line 188

def is_default=(value)
    @is_default = value
end

#is_initial ⇒ Object

Gets the isInitial property value. true if this is the initial domain created by Microsoft Online Services (companyname.onmicrosoft.com). There is only one initial domain per company. Not nullable

Returns:

  • a boolean



195
196
197
 
# File 'lib/models/domain.rb', line 195

def is_initial
    return @is_initial
end

#is_initial=(value) ⇒ Object

Sets the isInitial property value. true if this is the initial domain created by Microsoft Online Services (companyname.onmicrosoft.com). There is only one initial domain per company. Not nullable

Parameters:

  • value —

    Value to set for the isInitial property.

Returns:

  • a void



203
204
205
 
# File 'lib/models/domain.rb', line 203

def is_initial=(value)
    @is_initial = value
end

#is_root ⇒ Object

Gets the isRoot property value. true if the domain is a verified root domain. Otherwise, false if the domain is a subdomain or unverified. Not nullable

Returns:

  • a boolean



210
211
212
 
# File 'lib/models/domain.rb', line 210

def is_root
    return @is_root
end

#is_root=(value) ⇒ Object

Sets the isRoot property value. true if the domain is a verified root domain. Otherwise, false if the domain is a subdomain or unverified. Not nullable

Parameters:

  • value —

    Value to set for the isRoot property.

Returns:

  • a void



218
219
220
 
# File 'lib/models/domain.rb', line 218

def is_root=(value)
    @is_root = value
end

#is_verified ⇒ Object

Gets the isVerified property value. true if the domain has completed domain ownership verification. Not nullable

Returns:

  • a boolean



225
226
227
 
# File 'lib/models/domain.rb', line 225

def is_verified
    return @is_verified
end

#is_verified=(value) ⇒ Object

Sets the isVerified property value. true if the domain has completed domain ownership verification. Not nullable

Parameters:

  • value —

    Value to set for the isVerified property.

Returns:

  • a void



233
234
235
 
# File 'lib/models/domain.rb', line 233

def is_verified=(value)
    @is_verified = value
end

#manufacturer ⇒ Object

Gets the manufacturer property value. The manufacturer property

Returns:

  • a string



240
241
242
 
# File 'lib/models/domain.rb', line 240

def manufacturer
    return @manufacturer
end

#manufacturer=(value) ⇒ Object

Sets the manufacturer property value. The manufacturer property

Parameters:

  • value —

    Value to set for the manufacturer property.

Returns:

  • a void



248
249
250
 
# File 'lib/models/domain.rb', line 248

def manufacturer=(value)
    @manufacturer = value
end

#model ⇒ Object

Gets the model property value. The model property

Returns:

  • a string



255
256
257
 
# File 'lib/models/domain.rb', line 255

def model
    return @model
end

#model=(value) ⇒ Object

Sets the model property value. The model property

Parameters:

  • value —

    Value to set for the model property.

Returns:

  • a void



263
264
265
 
# File 'lib/models/domain.rb', line 263

def model=(value)
    @model = value
end

#password_notification_window_in_days ⇒ Object

Gets the passwordNotificationWindowInDays property value. Specifies the number of days before a user receives notification that their password will expire. If the property is not set, a default value of 14 days will be used.

Returns:

  • a integer



270
271
272
 
# File 'lib/models/domain.rb', line 270

def password_notification_window_in_days
    return @password_notification_window_in_days
end

#password_notification_window_in_days=(value) ⇒ Object

Sets the passwordNotificationWindowInDays property value. Specifies the number of days before a user receives notification that their password will expire. If the property is not set, a default value of 14 days will be used.

Parameters:

  • value —

    Value to set for the passwordNotificationWindowInDays property.

Returns:

  • a void



278
279
280
 
# File 'lib/models/domain.rb', line 278

def password_notification_window_in_days=(value)
    @password_notification_window_in_days = value
end

#password_validity_period_in_days ⇒ Object

Gets the passwordValidityPeriodInDays property value. Specifies the length of time that a password is valid before it must be changed. If the property is not set, a default value of 90 days will be used.

Returns:

  • a integer



285
286
287
 
# File 'lib/models/domain.rb', line 285

def password_validity_period_in_days
    return @password_validity_period_in_days
end

#password_validity_period_in_days=(value) ⇒ Object

Sets the passwordValidityPeriodInDays property value. Specifies the length of time that a password is valid before it must be changed. If the property is not set, a default value of 90 days will be used.

Parameters:

  • value —

    Value to set for the passwordValidityPeriodInDays property.

Returns:

  • a void



293
294
295
 
# File 'lib/models/domain.rb', line 293

def password_validity_period_in_days=(value)
    @password_validity_period_in_days = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer —

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError) 


301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/models/domain.rb', line 301

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_string_value("authenticationType", @authentication_type)
    writer.write_string_value("availabilityStatus", @availability_status)
    writer.write_collection_of_object_values("domainNameReferences", @domain_name_references)
    writer.write_collection_of_object_values("federationConfiguration", @federation_configuration)
    writer.write_boolean_value("isAdminManaged", @is_admin_managed)
    writer.write_boolean_value("isDefault", @is_default)
    writer.write_boolean_value("isInitial", @is_initial)
    writer.write_boolean_value("isRoot", @is_root)
    writer.write_boolean_value("isVerified", @is_verified)
    writer.write_string_value("manufacturer", @manufacturer)
    writer.write_string_value("model", @model)
    writer.write_number_value("passwordNotificationWindowInDays", @password_notification_window_in_days)
    writer.write_number_value("passwordValidityPeriodInDays", @password_validity_period_in_days)
    writer.write_collection_of_object_values("serviceConfigurationRecords", @service_configuration_records)
    writer.write_object_value("state", @state)
    writer.write_collection_of_primitive_values("supportedServices", @supported_services)
    writer.write_collection_of_object_values("verificationDnsRecords", @verification_dns_records)
end

#service_configuration_records ⇒ Object

Gets the serviceConfigurationRecords property value. DNS records the customer adds to the DNS zone file of the domain before the domain can be used by Microsoft Online services. Read-only, Nullable. Supports $expand.

Returns:

  • a domain_dns_record



326
327
328
 
# File 'lib/models/domain.rb', line 326

def service_configuration_records
    return @service_configuration_records
end

#service_configuration_records=(value) ⇒ Object

Sets the serviceConfigurationRecords property value. DNS records the customer adds to the DNS zone file of the domain before the domain can be used by Microsoft Online services. Read-only, Nullable. Supports $expand.

Parameters:

  • value —

    Value to set for the serviceConfigurationRecords property.

Returns:

  • a void



334
335
336
 
# File 'lib/models/domain.rb', line 334

def service_configuration_records=(value)
    @service_configuration_records = value
end

#state ⇒ Object

Gets the state property value. Status of asynchronous operations scheduled for the domain.

Returns:

  • a domain_state



341
342
343
 
# File 'lib/models/domain.rb', line 341

def state
    return @state
end

#state=(value) ⇒ Object

Sets the state property value. Status of asynchronous operations scheduled for the domain.

Parameters:

  • value —

    Value to set for the state property.

Returns:

  • a void



349
350
351
 
# File 'lib/models/domain.rb', line 349

def state=(value)
    @state = value
end

#supported_services ⇒ Object

Gets the supportedServices property value. The capabilities assigned to the domain. Can include 0, 1 or more of following values: Email, Sharepoint, EmailInternalRelayOnly, OfficeCommunicationsOnline, SharePointDefaultDomain, FullRedelegation, SharePointPublic, OrgIdAuthentication, Yammer, Intune. The values which you can add/remove using Graph API include: Email, OfficeCommunicationsOnline, Yammer. Not nullable.

Returns:

  • a string



356
357
358
 
# File 'lib/models/domain.rb', line 356

def supported_services
    return @supported_services
end

#supported_services=(value) ⇒ Object

Sets the supportedServices property value. The capabilities assigned to the domain. Can include 0, 1 or more of following values: Email, Sharepoint, EmailInternalRelayOnly, OfficeCommunicationsOnline, SharePointDefaultDomain, FullRedelegation, SharePointPublic, OrgIdAuthentication, Yammer, Intune. The values which you can add/remove using Graph API include: Email, OfficeCommunicationsOnline, Yammer. Not nullable.

Parameters:

  • value —

    Value to set for the supportedServices property.

Returns:

  • a void



364
365
366
 
# File 'lib/models/domain.rb', line 364

def supported_services=(value)
    @supported_services = value
end

#verification_dns_records ⇒ Object

Gets the verificationDnsRecords property value. DNS records that the customer adds to the DNS zone file of the domain before the customer can complete domain ownership verification with Azure AD. Read-only, Nullable. Supports $expand.

Returns:

  • a domain_dns_record



371
372
373
 
# File 'lib/models/domain.rb', line 371

def verification_dns_records
    return @verification_dns_records
end

#verification_dns_records=(value) ⇒ Object

Sets the verificationDnsRecords property value. DNS records that the customer adds to the DNS zone file of the domain before the customer can complete domain ownership verification with Azure AD. Read-only, Nullable. Supports $expand.

Parameters:

  • value —

    Value to set for the verificationDnsRecords property.

Returns:

  • a void



379
380
381
 
# File 'lib/models/domain.rb', line 379

def verification_dns_records=(value)
    @verification_dns_records = value
end