Class: MicrosoftGraph::Models::PolicyRoot

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/policy_root.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

#initializeObject

Instantiates a new policyRoot and sets the default values.



205
206
207
# File 'lib/models/policy_root.rb', line 205

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 policy_root

Raises:

  • (StandardError)


213
214
215
216
# File 'lib/models/policy_root.rb', line 213

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

Instance Method Details

#activity_based_timeout_policiesObject

Gets the activityBasedTimeoutPolicies property value. The policy that controls the idle time out for web sessions for applications.

Returns:

  • a activity_based_timeout_policy



70
71
72
# File 'lib/models/policy_root.rb', line 70

def activity_based_timeout_policies
    return @activity_based_timeout_policies
end

#activity_based_timeout_policies=(value) ⇒ Object

Sets the activityBasedTimeoutPolicies property value. The policy that controls the idle time out for web sessions for applications.

Parameters:

  • value

    Value to set for the activityBasedTimeoutPolicies property.

Returns:

  • a void



78
79
80
# File 'lib/models/policy_root.rb', line 78

def activity_based_timeout_policies=(value)
    @activity_based_timeout_policies = value
end

Gets the adminConsentRequestPolicy property value. The policy by which consent requests are created and managed for the entire tenant.

Returns:

  • a admin_consent_request_policy



85
86
87
# File 'lib/models/policy_root.rb', line 85

def admin_consent_request_policy
    return @admin_consent_request_policy
end

Sets the adminConsentRequestPolicy property value. The policy by which consent requests are created and managed for the entire tenant.

Parameters:

  • value

    Value to set for the adminConsentRequestPolicy property.

Returns:

  • a void



93
94
95
# File 'lib/models/policy_root.rb', line 93

def admin_consent_request_policy=(value)
    @admin_consent_request_policy = value
end

#app_management_policiesObject

Gets the appManagementPolicies property value. The policies that enforce app management restrictions for specific applications and service principals, overriding the defaultAppManagementPolicy.

Returns:

  • a app_management_policy



100
101
102
# File 'lib/models/policy_root.rb', line 100

def app_management_policies
    return @app_management_policies
end

#app_management_policies=(value) ⇒ Object

Sets the appManagementPolicies property value. The policies that enforce app management restrictions for specific applications and service principals, overriding the defaultAppManagementPolicy.

Parameters:

  • value

    Value to set for the appManagementPolicies property.

Returns:

  • a void



108
109
110
# File 'lib/models/policy_root.rb', line 108

def app_management_policies=(value)
    @app_management_policies = value
end

#authentication_flows_policyObject

Gets the authenticationFlowsPolicy property value. The policy configuration of the self-service sign-up experience of external users.

Returns:

  • a authentication_flows_policy



115
116
117
# File 'lib/models/policy_root.rb', line 115

def authentication_flows_policy
    return @authentication_flows_policy
end

#authentication_flows_policy=(value) ⇒ Object

Sets the authenticationFlowsPolicy property value. The policy configuration of the self-service sign-up experience of external users.

Parameters:

  • value

    Value to set for the authenticationFlowsPolicy property.

Returns:

  • a void



123
124
125
# File 'lib/models/policy_root.rb', line 123

def authentication_flows_policy=(value)
    @authentication_flows_policy = value
end

#authentication_methods_policyObject

Gets the authenticationMethodsPolicy property value. The authentication methods and the users that are allowed to use them to sign in and perform multifactor authentication (MFA) in Azure Active Directory (Azure AD).

Returns:

  • a authentication_methods_policy



130
131
132
# File 'lib/models/policy_root.rb', line 130

def authentication_methods_policy
    return @authentication_methods_policy
end

#authentication_methods_policy=(value) ⇒ Object

Sets the authenticationMethodsPolicy property value. The authentication methods and the users that are allowed to use them to sign in and perform multifactor authentication (MFA) in Azure Active Directory (Azure AD).

Parameters:

  • value

    Value to set for the authenticationMethodsPolicy property.

Returns:

  • a void



138
139
140
# File 'lib/models/policy_root.rb', line 138

def authentication_methods_policy=(value)
    @authentication_methods_policy = value
end

#authentication_strength_policiesObject

Gets the authenticationStrengthPolicies property value. The authentication method combinations that are to be used in scenarios defined by Azure AD Conditional Access.

Returns:

  • a authentication_strength_policy



145
146
147
# File 'lib/models/policy_root.rb', line 145

def authentication_strength_policies
    return @authentication_strength_policies
end

#authentication_strength_policies=(value) ⇒ Object

Sets the authenticationStrengthPolicies property value. The authentication method combinations that are to be used in scenarios defined by Azure AD Conditional Access.

Parameters:

  • value

    Value to set for the authenticationStrengthPolicies property.

Returns:

  • a void



153
154
155
# File 'lib/models/policy_root.rb', line 153

def authentication_strength_policies=(value)
    @authentication_strength_policies = value
end

#authorization_policyObject

Gets the authorizationPolicy property value. The policy that controls Azure AD authorization settings.

Returns:

  • a authorization_policy



160
161
162
# File 'lib/models/policy_root.rb', line 160

def authorization_policy
    return @authorization_policy
end

#authorization_policy=(value) ⇒ Object

Sets the authorizationPolicy property value. The policy that controls Azure AD authorization settings.

Parameters:

  • value

    Value to set for the authorizationPolicy property.

Returns:

  • a void



168
169
170
# File 'lib/models/policy_root.rb', line 168

def authorization_policy=(value)
    @authorization_policy = value
end

#claims_mapping_policiesObject

Gets the claimsMappingPolicies property value. The claim-mapping policies for WS-Fed, SAML, OAuth 2.0, and OpenID Connect protocols, for tokens issued to a specific application.

Returns:

  • a claims_mapping_policy



175
176
177
# File 'lib/models/policy_root.rb', line 175

def claims_mapping_policies
    return @claims_mapping_policies
end

#claims_mapping_policies=(value) ⇒ Object

Sets the claimsMappingPolicies property value. The claim-mapping policies for WS-Fed, SAML, OAuth 2.0, and OpenID Connect protocols, for tokens issued to a specific application.

Parameters:

  • value

    Value to set for the claimsMappingPolicies property.

Returns:

  • a void



183
184
185
# File 'lib/models/policy_root.rb', line 183

def claims_mapping_policies=(value)
    @claims_mapping_policies = value
end

#conditional_access_policiesObject

Gets the conditionalAccessPolicies property value. The custom rules that define an access scenario.

Returns:

  • a conditional_access_policy



190
191
192
# File 'lib/models/policy_root.rb', line 190

def conditional_access_policies
    return @conditional_access_policies
end

#conditional_access_policies=(value) ⇒ Object

Sets the conditionalAccessPolicies property value. The custom rules that define an access scenario.

Parameters:

  • value

    Value to set for the conditionalAccessPolicies property.

Returns:

  • a void



198
199
200
# File 'lib/models/policy_root.rb', line 198

def conditional_access_policies=(value)
    @conditional_access_policies = value
end

#cross_tenant_access_policyObject

Gets the crossTenantAccessPolicy property value. The custom rules that define an access scenario when interacting with external Azure AD tenants.

Returns:

  • a cross_tenant_access_policy



221
222
223
# File 'lib/models/policy_root.rb', line 221

def cross_tenant_access_policy
    return @cross_tenant_access_policy
end

#cross_tenant_access_policy=(value) ⇒ Object

Sets the crossTenantAccessPolicy property value. The custom rules that define an access scenario when interacting with external Azure AD tenants.

Parameters:

  • value

    Value to set for the crossTenantAccessPolicy property.

Returns:

  • a void



229
230
231
# File 'lib/models/policy_root.rb', line 229

def cross_tenant_access_policy=(value)
    @cross_tenant_access_policy = value
end

#default_app_management_policyObject

Gets the defaultAppManagementPolicy property value. The tenant-wide policy that enforces app management restrictions for all applications and service principals.

Returns:

  • a tenant_app_management_policy



236
237
238
# File 'lib/models/policy_root.rb', line 236

def default_app_management_policy
    return @default_app_management_policy
end

#default_app_management_policy=(value) ⇒ Object

Sets the defaultAppManagementPolicy property value. The tenant-wide policy that enforces app management restrictions for all applications and service principals.

Parameters:

  • value

    Value to set for the defaultAppManagementPolicy property.

Returns:

  • a void



244
245
246
# File 'lib/models/policy_root.rb', line 244

def default_app_management_policy=(value)
    @default_app_management_policy = value
end

#feature_rollout_policiesObject

Gets the featureRolloutPolicies property value. The feature rollout policy associated with a directory object.

Returns:

  • a feature_rollout_policy



251
252
253
# File 'lib/models/policy_root.rb', line 251

def feature_rollout_policies
    return @feature_rollout_policies
end

#feature_rollout_policies=(value) ⇒ Object

Sets the featureRolloutPolicies property value. The feature rollout policy associated with a directory object.

Parameters:

  • value

    Value to set for the featureRolloutPolicies property.

Returns:

  • a void



259
260
261
# File 'lib/models/policy_root.rb', line 259

def feature_rollout_policies=(value)
    @feature_rollout_policies = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'lib/models/policy_root.rb', line 266

def get_field_deserializers()
    return super.merge({
        "activityBasedTimeoutPolicies" => lambda {|n| @activity_based_timeout_policies = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ActivityBasedTimeoutPolicy.create_from_discriminator_value(pn) }) },
        "adminConsentRequestPolicy" => lambda {|n| @admin_consent_request_policy = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::AdminConsentRequestPolicy.create_from_discriminator_value(pn) }) },
        "appManagementPolicies" => lambda {|n| @app_management_policies = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AppManagementPolicy.create_from_discriminator_value(pn) }) },
        "authenticationFlowsPolicy" => lambda {|n| @authentication_flows_policy = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::AuthenticationFlowsPolicy.create_from_discriminator_value(pn) }) },
        "authenticationMethodsPolicy" => lambda {|n| @authentication_methods_policy = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::AuthenticationMethodsPolicy.create_from_discriminator_value(pn) }) },
        "authenticationStrengthPolicies" => lambda {|n| @authentication_strength_policies = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AuthenticationStrengthPolicy.create_from_discriminator_value(pn) }) },
        "authorizationPolicy" => lambda {|n| @authorization_policy = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::AuthorizationPolicy.create_from_discriminator_value(pn) }) },
        "claimsMappingPolicies" => lambda {|n| @claims_mapping_policies = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ClaimsMappingPolicy.create_from_discriminator_value(pn) }) },
        "conditionalAccessPolicies" => lambda {|n| @conditional_access_policies = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ConditionalAccessPolicy.create_from_discriminator_value(pn) }) },
        "crossTenantAccessPolicy" => lambda {|n| @cross_tenant_access_policy = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::CrossTenantAccessPolicy.create_from_discriminator_value(pn) }) },
        "defaultAppManagementPolicy" => lambda {|n| @default_app_management_policy = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::TenantAppManagementPolicy.create_from_discriminator_value(pn) }) },
        "featureRolloutPolicies" => lambda {|n| @feature_rollout_policies = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::FeatureRolloutPolicy.create_from_discriminator_value(pn) }) },
        "homeRealmDiscoveryPolicies" => lambda {|n| @home_realm_discovery_policies = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::HomeRealmDiscoveryPolicy.create_from_discriminator_value(pn) }) },
        "identitySecurityDefaultsEnforcementPolicy" => lambda {|n| @identity_security_defaults_enforcement_policy = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::IdentitySecurityDefaultsEnforcementPolicy.create_from_discriminator_value(pn) }) },
        "permissionGrantPolicies" => lambda {|n| @permission_grant_policies = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::PermissionGrantPolicy.create_from_discriminator_value(pn) }) },
        "roleManagementPolicies" => lambda {|n| @role_management_policies = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::UnifiedRoleManagementPolicy.create_from_discriminator_value(pn) }) },
        "roleManagementPolicyAssignments" => lambda {|n| @role_management_policy_assignments = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::UnifiedRoleManagementPolicyAssignment.create_from_discriminator_value(pn) }) },
        "tokenIssuancePolicies" => lambda {|n| @token_issuance_policies = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::TokenIssuancePolicy.create_from_discriminator_value(pn) }) },
        "tokenLifetimePolicies" => lambda {|n| @token_lifetime_policies = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::TokenLifetimePolicy.create_from_discriminator_value(pn) }) },
    })
end

#home_realm_discovery_policiesObject

Gets the homeRealmDiscoveryPolicies property value. The policy to control Azure AD authentication behavior for federated users.

Returns:

  • a home_realm_discovery_policy



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

def home_realm_discovery_policies
    return @home_realm_discovery_policies
end

#home_realm_discovery_policies=(value) ⇒ Object

Sets the homeRealmDiscoveryPolicies property value. The policy to control Azure AD authentication behavior for federated users.

Parameters:

  • value

    Value to set for the homeRealmDiscoveryPolicies property.

Returns:

  • a void



301
302
303
# File 'lib/models/policy_root.rb', line 301

def home_realm_discovery_policies=(value)
    @home_realm_discovery_policies = value
end

#identity_security_defaults_enforcement_policyObject

Gets the identitySecurityDefaultsEnforcementPolicy property value. The policy that represents the security defaults that protect against common attacks.

Returns:

  • a identity_security_defaults_enforcement_policy



308
309
310
# File 'lib/models/policy_root.rb', line 308

def identity_security_defaults_enforcement_policy
    return @identity_security_defaults_enforcement_policy
end

#identity_security_defaults_enforcement_policy=(value) ⇒ Object

Sets the identitySecurityDefaultsEnforcementPolicy property value. The policy that represents the security defaults that protect against common attacks.

Parameters:

  • value

    Value to set for the identitySecurityDefaultsEnforcementPolicy property.

Returns:

  • a void



316
317
318
# File 'lib/models/policy_root.rb', line 316

def identity_security_defaults_enforcement_policy=(value)
    @identity_security_defaults_enforcement_policy = value
end

#permission_grant_policiesObject

Gets the permissionGrantPolicies property value. The policy that specifies the conditions under which consent can be granted.

Returns:

  • a permission_grant_policy



323
324
325
# File 'lib/models/policy_root.rb', line 323

def permission_grant_policies
    return @permission_grant_policies
end

#permission_grant_policies=(value) ⇒ Object

Sets the permissionGrantPolicies property value. The policy that specifies the conditions under which consent can be granted.

Parameters:

  • value

    Value to set for the permissionGrantPolicies property.

Returns:

  • a void



331
332
333
# File 'lib/models/policy_root.rb', line 331

def permission_grant_policies=(value)
    @permission_grant_policies = value
end

#role_management_policiesObject

Gets the roleManagementPolicies property value. Specifies the various policies associated with scopes and roles.

Returns:

  • a unified_role_management_policy



338
339
340
# File 'lib/models/policy_root.rb', line 338

def role_management_policies
    return @role_management_policies
end

#role_management_policies=(value) ⇒ Object

Sets the roleManagementPolicies property value. Specifies the various policies associated with scopes and roles.

Parameters:

  • value

    Value to set for the roleManagementPolicies property.

Returns:

  • a void



346
347
348
# File 'lib/models/policy_root.rb', line 346

def role_management_policies=(value)
    @role_management_policies = value
end

#role_management_policy_assignmentsObject

Gets the roleManagementPolicyAssignments property value. The assignment of a role management policy to a role definition object.

Returns:

  • a unified_role_management_policy_assignment



353
354
355
# File 'lib/models/policy_root.rb', line 353

def role_management_policy_assignments
    return @role_management_policy_assignments
end

#role_management_policy_assignments=(value) ⇒ Object

Sets the roleManagementPolicyAssignments property value. The assignment of a role management policy to a role definition object.

Parameters:

  • value

    Value to set for the roleManagementPolicyAssignments property.

Returns:

  • a void



361
362
363
# File 'lib/models/policy_root.rb', line 361

def role_management_policy_assignments=(value)
    @role_management_policy_assignments = 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)


369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
# File 'lib/models/policy_root.rb', line 369

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_collection_of_object_values("activityBasedTimeoutPolicies", @activity_based_timeout_policies)
    writer.write_object_value("adminConsentRequestPolicy", @admin_consent_request_policy)
    writer.write_collection_of_object_values("appManagementPolicies", @app_management_policies)
    writer.write_object_value("authenticationFlowsPolicy", @authentication_flows_policy)
    writer.write_object_value("authenticationMethodsPolicy", @authentication_methods_policy)
    writer.write_collection_of_object_values("authenticationStrengthPolicies", @authentication_strength_policies)
    writer.write_object_value("authorizationPolicy", @authorization_policy)
    writer.write_collection_of_object_values("claimsMappingPolicies", @claims_mapping_policies)
    writer.write_collection_of_object_values("conditionalAccessPolicies", @conditional_access_policies)
    writer.write_object_value("crossTenantAccessPolicy", @cross_tenant_access_policy)
    writer.write_object_value("defaultAppManagementPolicy", @default_app_management_policy)
    writer.write_collection_of_object_values("featureRolloutPolicies", @feature_rollout_policies)
    writer.write_collection_of_object_values("homeRealmDiscoveryPolicies", @home_realm_discovery_policies)
    writer.write_object_value("identitySecurityDefaultsEnforcementPolicy", @identity_security_defaults_enforcement_policy)
    writer.write_collection_of_object_values("permissionGrantPolicies", @permission_grant_policies)
    writer.write_collection_of_object_values("roleManagementPolicies", @role_management_policies)
    writer.write_collection_of_object_values("roleManagementPolicyAssignments", @role_management_policy_assignments)
    writer.write_collection_of_object_values("tokenIssuancePolicies", @token_issuance_policies)
    writer.write_collection_of_object_values("tokenLifetimePolicies", @token_lifetime_policies)
end

#token_issuance_policiesObject

Gets the tokenIssuancePolicies property value. The policy that specifies the characteristics of SAML tokens issued by Azure AD.

Returns:

  • a token_issuance_policy



396
397
398
# File 'lib/models/policy_root.rb', line 396

def token_issuance_policies
    return @token_issuance_policies
end

#token_issuance_policies=(value) ⇒ Object

Sets the tokenIssuancePolicies property value. The policy that specifies the characteristics of SAML tokens issued by Azure AD.

Parameters:

  • value

    Value to set for the tokenIssuancePolicies property.

Returns:

  • a void



404
405
406
# File 'lib/models/policy_root.rb', line 404

def token_issuance_policies=(value)
    @token_issuance_policies = value
end

#token_lifetime_policiesObject

Gets the tokenLifetimePolicies property value. The policy that controls the lifetime of a JWT access token, an ID token, or a SAML 1.1/2.0 token issued by Azure AD.

Returns:

  • a token_lifetime_policy



411
412
413
# File 'lib/models/policy_root.rb', line 411

def token_lifetime_policies
    return @token_lifetime_policies
end

#token_lifetime_policies=(value) ⇒ Object

Sets the tokenLifetimePolicies property value. The policy that controls the lifetime of a JWT access token, an ID token, or a SAML 1.1/2.0 token issued by Azure AD.

Parameters:

  • value

    Value to set for the tokenLifetimePolicies property.

Returns:

  • a void



419
420
421
# File 'lib/models/policy_root.rb', line 419

def token_lifetime_policies=(value)
    @token_lifetime_policies = value
end