Class: SDM::SQLServerKerberosAD

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(allow_deprecated_encryption: nil, bind_interface: nil, database: nil, egress_filter: nil, healthy: nil, hostname: nil, id: nil, keytab: nil, krb_config: nil, name: nil, override_database: nil, port: nil, port_override: nil, proxy_cluster_id: nil, realm: nil, schema: nil, secret_store_id: nil, server_spn: nil, subdomain: nil, tags: nil, username: nil) ⇒ SQLServerKerberosAD

Returns a new instance of SQLServerKerberosAD.



15501
15502
15503
15504
15505
15506
15507
15508
15509
15510
15511
15512
15513
15514
15515
15516
15517
15518
15519
15520
15521
15522
15523
15524
15525
15526
15527
15528
15529
15530
15531
15532
15533
15534
15535
15536
15537
15538
15539
15540
15541
15542
15543
15544
15545
# File 'lib/models/porcelain.rb', line 15501

def initialize(
  allow_deprecated_encryption: nil,
  bind_interface: nil,
  database: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  keytab: nil,
  krb_config: nil,
  name: nil,
  override_database: nil,
  port: nil,
  port_override: nil,
  proxy_cluster_id: nil,
  realm: nil,
  schema: nil,
  secret_store_id: nil,
  server_spn: nil,
  subdomain: nil,
  tags: nil,
  username: nil
)
  @allow_deprecated_encryption = allow_deprecated_encryption == nil ? false : allow_deprecated_encryption
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @database = database == nil ? "" : database
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @healthy = healthy == nil ? false : healthy
  @hostname = hostname == nil ? "" : hostname
  @id = id == nil ? "" : id
  @keytab = keytab == nil ? "" : keytab
  @krb_config = krb_config == nil ? "" : krb_config
  @name = name == nil ? "" : name
  @override_database = override_database == nil ? false : override_database
  @port = port == nil ? 0 : port
  @port_override = port_override == nil ? 0 : port_override
  @proxy_cluster_id = proxy_cluster_id == nil ? "" : proxy_cluster_id
  @realm = realm == nil ? "" : realm
  @schema = schema == nil ? "" : schema
  @secret_store_id = secret_store_id == nil ? "" : secret_store_id
  @server_spn = server_spn == nil ? "" : server_spn
  @subdomain = subdomain == nil ? "" : subdomain
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
  @username = username == nil ? "" : username
end

Instance Attribute Details

#allow_deprecated_encryptionObject

Whether to allow deprecated encryption protocols to be used for this resource. For example, TLS 1.0.



15459
15460
15461
# File 'lib/models/porcelain.rb', line 15459

def allow_deprecated_encryption
  @allow_deprecated_encryption
end

#bind_interfaceObject

The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided and may also be set to one of the ResourceIPAllocationMode constants to select between VNM, loopback, or default allocation.



15461
15462
15463
# File 'lib/models/porcelain.rb', line 15461

def bind_interface
  @bind_interface
end

#databaseObject

The database for healthchecks, and used for clients if Override Default Database is true.



15463
15464
15465
# File 'lib/models/porcelain.rb', line 15463

def database
  @database
end

#egress_filterObject

A filter applied to the routing logic to pin datasource to nodes.



15465
15466
15467
# File 'lib/models/porcelain.rb', line 15465

def egress_filter
  @egress_filter
end

#healthyObject

True if the datasource is reachable and the credentials are valid.



15467
15468
15469
# File 'lib/models/porcelain.rb', line 15467

def healthy
  @healthy
end

#hostnameObject

The host to dial to initiate a connection from the egress node to this resource.



15469
15470
15471
# File 'lib/models/porcelain.rb', line 15469

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



15471
15472
15473
# File 'lib/models/porcelain.rb', line 15471

def id
  @id
end

#keytabObject

The keytab file in base64 format containing an entry with the principal name (username@realm) and key version number with which to authenticate.



15473
15474
15475
# File 'lib/models/porcelain.rb', line 15473

def keytab
  @keytab
end

#krb_configObject

The Kerberos 5 configuration file (krb5.conf) specifying the Active Directory server (KDC) for the configured realm.



15475
15476
15477
# File 'lib/models/porcelain.rb', line 15475

def krb_config
  @krb_config
end

#nameObject

Unique human-readable name of the Resource.



15477
15478
15479
# File 'lib/models/porcelain.rb', line 15477

def name
  @name
end

#override_databaseObject

If set, the database configured cannot be changed by users. This setting is not recommended for most use cases, as some clients will insist their database has changed when it has not, leading to user confusion.



15479
15480
15481
# File 'lib/models/porcelain.rb', line 15479

def override_database
  @override_database
end

#portObject

The port to dial to initiate a connection from the egress node to this resource.



15481
15482
15483
# File 'lib/models/porcelain.rb', line 15481

def port
  @port
end

#port_overrideObject

The local port used by clients to connect to this resource. It is automatically generated if not provided on create and may be re-generated on update by specifying a value of -1.



15483
15484
15485
# File 'lib/models/porcelain.rb', line 15483

def port_override
  @port_override
end

#proxy_cluster_idObject

ID of the proxy cluster for this resource, if any.



15485
15486
15487
# File 'lib/models/porcelain.rb', line 15485

def proxy_cluster_id
  @proxy_cluster_id
end

#realmObject

The Active Directory domain (realm) to which the configured username belongs.



15487
15488
15489
# File 'lib/models/porcelain.rb', line 15487

def realm
  @realm
end

#schemaObject

The Schema to use to direct initial requests.



15489
15490
15491
# File 'lib/models/porcelain.rb', line 15489

def schema
  @schema
end

#secret_store_idObject

ID of the secret store containing credentials for this resource, if any.



15491
15492
15493
# File 'lib/models/porcelain.rb', line 15491

def secret_store_id
  @secret_store_id
end

#server_spnObject

The Service Principal Name of the Microsoft SQL Server instance in Active Directory.



15493
15494
15495
# File 'lib/models/porcelain.rb', line 15493

def server_spn
  @server_spn
end

#subdomainObject

DNS subdomain through which this resource may be accessed on clients. (e.g. "app-prod1" allows the resource to be accessed at "app-prod1.your-org-name.sdm-proxy-domain"). Only applicable to HTTP-based resources or resources using virtual networking mode.



15495
15496
15497
# File 'lib/models/porcelain.rb', line 15495

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



15497
15498
15499
# File 'lib/models/porcelain.rb', line 15497

def tags
  @tags
end

#usernameObject

The username to authenticate with.



15499
15500
15501
# File 'lib/models/porcelain.rb', line 15499

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



15547
15548
15549
15550
15551
15552
15553
# File 'lib/models/porcelain.rb', line 15547

def to_json(options = {})
  hash = {}
  self.instance_variables.each do |var|
    hash[var.id2name.delete_prefix("@")] = self.instance_variable_get var
  end
  hash.to_json
end