Class: Azure::KeyVault::Mgmt::V2019_09_01::Models::Key

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-09-01/generated/azure_mgmt_key_vault/models/key.rb

Overview

The key resource.

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #location, #name, #tags, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#attributes ⇒ KeyAttributes

Returns The attributes of the key.

Returns:



16
17
18
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/key.rb', line 16

def attributes
  @attributes
end

#curve_name ⇒ JsonWebKeyCurveName

values, see JsonWebKeyCurveName. Possible values include: ‘P-256’, ‘P-384’, ‘P-521’, ‘P-256K’

Returns:



33
34
35
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/key.rb', line 33

def curve_name
  @curve_name
end

#key_ops ⇒ Array<JsonWebKeyOperation>

Returns:



24
25
26
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/key.rb', line 24

def key_ops
  @key_ops
end

#key_size ⇒ Integer

4096 for RSA.

Returns:

  • (Integer) —

    The key size in bits. For example: 2048, 3072, or



28
29
30
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/key.rb', line 28

def key_size
  @key_size
end

#key_uri ⇒ String

Returns The URI to retrieve the current version of the key.

Returns:

  • (String) —

    The URI to retrieve the current version of the key.



36
37
38
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/key.rb', line 36

def key_uri
  @key_uri
end

#key_uri_with_version ⇒ String

Returns The URI to retrieve the specific version of the key.

Returns:

  • (String) —

    The URI to retrieve the specific version of the key.



39
40
41
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/key.rb', line 39

def key_uri_with_version
  @key_uri_with_version
end

#kty ⇒ JsonWebKeyType

JsonWebKeyType. Possible values include: ‘EC’, ‘EC-HSM’, ‘RSA’, ‘RSA-HSM’

Returns:



21
22
23
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/key.rb', line 21

def kty
  @kty
end

Class Method Details

.mapper ⇒ Object

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



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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/key.rb', line 46

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Key',
    type: {
      name: 'Composite',
      class_name: 'Key',
      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'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        location: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        attributes: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.attributes',
          type: {
            name: 'Composite',
            class_name: 'KeyAttributes'
          }
        },
        kty: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.kty',
          constraints: {
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        key_ops: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.keyOps',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'JsonWebKeyOperationElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        key_size: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.keySize',
          type: {
            name: 'Number'
          }
        },
        curve_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.curveName',
          type: {
            name: 'String'
          }
        },
        key_uri: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.keyUri',
          type: {
            name: 'String'
          }
        },
        key_uri_with_version: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.keyUriWithVersion',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end