Class: Azure::KeyVault::V7_0::Models::KeyProperties

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/7.0/generated/azure_key_vault/models/key_properties.rb

Overview

Properties of the key pair backing a certificate.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#curveJsonWebKeyCurveName

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

Returns:



34
35
36
# File 'lib/7.0/generated/azure_key_vault/models/key_properties.rb', line 34

def curve
  @curve
end

#exportableBoolean

Returns Indicates if the private key can be exported.

Returns:

  • (Boolean)

    Indicates if the private key can be exported.



16
17
18
# File 'lib/7.0/generated/azure_key_vault/models/key_properties.rb', line 16

def exportable
  @exportable
end

#key_sizeInteger

4096 for RSA.

Returns:

  • (Integer)

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



25
26
27
# File 'lib/7.0/generated/azure_key_vault/models/key_properties.rb', line 25

def key_size
  @key_size
end

#key_typeJsonWebKeyType

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

Returns:



21
22
23
# File 'lib/7.0/generated/azure_key_vault/models/key_properties.rb', line 21

def key_type
  @key_type
end

#reuse_keyBoolean

certificate renewal.

Returns:

  • (Boolean)

    Indicates if the same key pair will be used on



29
30
31
# File 'lib/7.0/generated/azure_key_vault/models/key_properties.rb', line 29

def reuse_key
  @reuse_key
end

Class Method Details

.mapperObject

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



41
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
# File 'lib/7.0/generated/azure_key_vault/models/key_properties.rb', line 41

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'KeyProperties',
    type: {
      name: 'Composite',
      class_name: 'KeyProperties',
      model_properties: {
        exportable: {
          client_side_validation: true,
          required: false,
          serialized_name: 'exportable',
          type: {
            name: 'Boolean'
          }
        },
        key_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'kty',
          type: {
            name: 'String'
          }
        },
        key_size: {
          client_side_validation: true,
          required: false,
          serialized_name: 'key_size',
          type: {
            name: 'Number'
          }
        },
        reuse_key: {
          client_side_validation: true,
          required: false,
          serialized_name: 'reuse_key',
          type: {
            name: 'Boolean'
          }
        },
        curve: {
          client_side_validation: true,
          required: false,
          serialized_name: 'crv',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end