Class: Azure::Appconfiguration::Mgmt::V2020_06_01::Models::ApiKey

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-06-01/generated/azure_mgmt_appconfiguration/models/api_key.rb

Overview

An API key used for authenticating with a configuration store endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#connection_string ⇒ String

clients for authentication.

Returns:

  • (String) —

    A connection string that can be used by supporting



27
28
29
 
# File 'lib/2020-06-01/generated/azure_mgmt_appconfiguration/models/api_key.rb', line 27

def connection_string
  @connection_string
end

#id ⇒ String

Returns The key ID.

Returns:

  • (String) —

    The key ID.



16
17
18
 
# File 'lib/2020-06-01/generated/azure_mgmt_appconfiguration/models/api_key.rb', line 16

def id
  @id
end

#last_modified ⇒ DateTime

modified.

Returns:

  • (DateTime) —

    The last time any of the key’s properties were



31
32
33
 
# File 'lib/2020-06-01/generated/azure_mgmt_appconfiguration/models/api_key.rb', line 31

def last_modified
  @last_modified
end

#name ⇒ String

Returns A name for the key describing its usage.

Returns:

  • (String) —

    A name for the key describing its usage.



19
20
21
 
# File 'lib/2020-06-01/generated/azure_mgmt_appconfiguration/models/api_key.rb', line 19

def name
  @name
end

#read_only ⇒ Boolean

operations.

Returns:

  • (Boolean) —

    Whether this key can only be used for read



35
36
37
 
# File 'lib/2020-06-01/generated/azure_mgmt_appconfiguration/models/api_key.rb', line 35

def read_only
  @read_only
end

#value ⇒ String

purposes.

Returns:

  • (String) —

    The value of the key that is used for authentication



23
24
25
 
# File 'lib/2020-06-01/generated/azure_mgmt_appconfiguration/models/api_key.rb', line 23

def value
  @value
end

Class Method Details

.mapper ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
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
 
# File 'lib/2020-06-01/generated/azure_mgmt_appconfiguration/models/api_key.rb', line 42

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ApiKey',
    type: {
      name: 'Composite',
      class_name: 'ApiKey',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        value: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'value',
          type: {
            name: 'String'
          }
        },
        connection_string: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'connectionString',
          type: {
            name: 'String'
          }
        },
        last_modified: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'lastModified',
          type: {
            name: 'DateTime'
          }
        },
        read_only: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'readOnly',
          type: {
            name: 'Boolean'
          }
        }
      }
    }
  }
end