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.



14893
14894
14895
14896
14897
14898
14899
14900
14901
14902
14903
14904
14905
14906
14907
14908
14909
14910
14911
14912
14913
14914
14915
14916
14917
14918
14919
14920
14921
14922
14923
14924
14925
14926
14927
14928
14929
14930
14931
14932
14933
14934
14935
14936
14937
# File 'lib/models/porcelain.rb', line 14893

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.



14851
14852
14853
# File 'lib/models/porcelain.rb', line 14851

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.



14853
14854
14855
# File 'lib/models/porcelain.rb', line 14853

def bind_interface
  @bind_interface
end

#databaseObject

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



14855
14856
14857
# File 'lib/models/porcelain.rb', line 14855

def database
  @database
end

#egress_filterObject

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



14857
14858
14859
# File 'lib/models/porcelain.rb', line 14857

def egress_filter
  @egress_filter
end

#healthyObject

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



14859
14860
14861
# File 'lib/models/porcelain.rb', line 14859

def healthy
  @healthy
end

#hostnameObject

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



14861
14862
14863
# File 'lib/models/porcelain.rb', line 14861

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



14863
14864
14865
# File 'lib/models/porcelain.rb', line 14863

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.



14865
14866
14867
# File 'lib/models/porcelain.rb', line 14865

def keytab
  @keytab
end

#krb_configObject

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



14867
14868
14869
# File 'lib/models/porcelain.rb', line 14867

def krb_config
  @krb_config
end

#nameObject

Unique human-readable name of the Resource.



14869
14870
14871
# File 'lib/models/porcelain.rb', line 14869

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.



14871
14872
14873
# File 'lib/models/porcelain.rb', line 14871

def override_database
  @override_database
end

#portObject

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



14873
14874
14875
# File 'lib/models/porcelain.rb', line 14873

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.



14875
14876
14877
# File 'lib/models/porcelain.rb', line 14875

def port_override
  @port_override
end

#proxy_cluster_idObject

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



14877
14878
14879
# File 'lib/models/porcelain.rb', line 14877

def proxy_cluster_id
  @proxy_cluster_id
end

#realmObject

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



14879
14880
14881
# File 'lib/models/porcelain.rb', line 14879

def realm
  @realm
end

#schemaObject

The Schema to use to direct initial requests.



14881
14882
14883
# File 'lib/models/porcelain.rb', line 14881

def schema
  @schema
end

#secret_store_idObject

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



14883
14884
14885
# File 'lib/models/porcelain.rb', line 14883

def secret_store_id
  @secret_store_id
end

#server_spnObject

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



14885
14886
14887
# File 'lib/models/porcelain.rb', line 14885

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.



14887
14888
14889
# File 'lib/models/porcelain.rb', line 14887

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



14889
14890
14891
# File 'lib/models/porcelain.rb', line 14889

def tags
  @tags
end

#usernameObject

The username to authenticate with.



14891
14892
14893
# File 'lib/models/porcelain.rb', line 14891

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



14939
14940
14941
14942
14943
14944
14945
# File 'lib/models/porcelain.rb', line 14939

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