Class: Azure::KeyVault::Mgmt::V2019_09_01::Models::VaultProperties

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

Overview

Properties of the vault

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#access_policies ⇒ Array<AccessPolicyEntry>

that have access to the key vault. All identities in the array must use the same tenant ID as the key vault’s tenant ID. When ‘createMode` is set to `recover`, access policies are not required. Otherwise, access policies are required.

Returns:



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

def access_policies
  @access_policies
end

#create_mode ⇒ CreateMode

vault need to be recovered or not. Possible values include: ‘recover’, ‘default’

Returns:

  • (CreateMode) —

    The vault’s create mode to indicate whether the



71
72
73
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/vault_properties.rb', line 71

def create_mode
  @create_mode
end

#enable_purge_protection ⇒ Boolean

is enabled for this vault. Setting this property to true activates protection against purge for this vault and its content - only the Key Vault service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible - that is, the property does not accept false as its value.

Returns:

  • (Boolean) —

    Property specifying whether protection against purge



80
81
82
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/vault_properties.rb', line 80

def enable_purge_protection
  @enable_purge_protection
end

#enable_rbac_authorization ⇒ Boolean

authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored (warning: this is a preview feature). When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC. Default value: false .

Returns:

  • (Boolean) —

    Property that controls how data actions are



66
67
68
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/vault_properties.rb', line 66

def enable_rbac_authorization
  @enable_rbac_authorization
end

#enable_soft_delete ⇒ Boolean

functionality is enabled for this key vault. If it’s not set to any value(true or false) when creating new key vault, it will be set to true by default. Once set to true, it cannot be reverted to false. Default value: true .

Returns:

  • (Boolean) —

    Property to specify whether the ‘soft delete’



51
52
53
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/vault_properties.rb', line 51

def enable_soft_delete
  @enable_soft_delete
end

#enabled_for_deployment ⇒ Boolean

are permitted to retrieve certificates stored as secrets from the key vault.

Returns:

  • (Boolean) —

    Property to specify whether Azure Virtual Machines



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

def enabled_for_deployment
  @enabled_for_deployment
end

#enabled_for_disk_encryption ⇒ Boolean

permitted to retrieve secrets from the vault and unwrap keys.

Returns:

  • (Boolean) —

    Property to specify whether Azure Disk Encryption is



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

def enabled_for_disk_encryption
  @enabled_for_disk_encryption
end

#enabled_for_template_deployment ⇒ Boolean

permitted to retrieve secrets from the key vault.

Returns:

  • (Boolean) —

    Property to specify whether Azure Resource Manager is



44
45
46
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/vault_properties.rb', line 44

def enabled_for_template_deployment
  @enabled_for_template_deployment
end

#network_acls ⇒ NetworkRuleSet

vault from specific network locations.

Returns:



84
85
86
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/vault_properties.rb', line 84

def network_acls
  @network_acls
end

#private_endpoint_connections ⇒ Array<PrivateEndpointConnectionItem>

connections associated with the key vault.

Returns:



88
89
90
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/vault_properties.rb', line 88

def private_endpoint_connections
  @private_endpoint_connections
end

#sku ⇒ Sku

Returns SKU details.

Returns:

  • (Sku) —

    SKU details



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

def sku
  @sku
end

#soft_delete_retention_in_days ⇒ Integer

<=90. Default value: 90 .

Returns:

  • (Integer) —

    softDelete data retention days. It accepts >=7 and



55
56
57
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/vault_properties.rb', line 55

def soft_delete_retention_in_days
  @soft_delete_retention_in_days
end

#tenant_id ⇒ Object

authenticating requests to the key vault.

Returns:

  • The Azure Active Directory tenant ID that should be used for



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

def tenant_id
  @tenant_id
end

#vault_uri ⇒ String

and secrets.

Returns:

  • (String) —

    The URI of the vault for performing operations on keys



31
32
33
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/vault_properties.rb', line 31

def vault_uri
  @vault_uri
end

Class Method Details

.mapper ⇒ Object

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



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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/vault_properties.rb', line 95

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'VaultProperties',
    type: {
      name: 'Composite',
      class_name: 'VaultProperties',
      model_properties: {
        tenant_id: {
          client_side_validation: true,
          required: true,
          serialized_name: 'tenantId',
          type: {
            name: 'String'
          }
        },
        sku: {
          client_side_validation: true,
          required: true,
          serialized_name: 'sku',
          default_value: {},
          type: {
            name: 'Composite',
            class_name: 'Sku'
          }
        },
        access_policies: {
          client_side_validation: true,
          required: false,
          serialized_name: 'accessPolicies',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'AccessPolicyEntryElementType',
                type: {
                  name: 'Composite',
                  class_name: 'AccessPolicyEntry'
                }
            }
          }
        },
        vault_uri: {
          client_side_validation: true,
          required: false,
          serialized_name: 'vaultUri',
          type: {
            name: 'String'
          }
        },
        enabled_for_deployment: {
          client_side_validation: true,
          required: false,
          serialized_name: 'enabledForDeployment',
          type: {
            name: 'Boolean'
          }
        },
        enabled_for_disk_encryption: {
          client_side_validation: true,
          required: false,
          serialized_name: 'enabledForDiskEncryption',
          type: {
            name: 'Boolean'
          }
        },
        enabled_for_template_deployment: {
          client_side_validation: true,
          required: false,
          serialized_name: 'enabledForTemplateDeployment',
          type: {
            name: 'Boolean'
          }
        },
        enable_soft_delete: {
          client_side_validation: true,
          required: false,
          serialized_name: 'enableSoftDelete',
          default_value: true,
          type: {
            name: 'Boolean'
          }
        },
        soft_delete_retention_in_days: {
          client_side_validation: true,
          required: false,
          serialized_name: 'softDeleteRetentionInDays',
          default_value: 90,
          type: {
            name: 'Number'
          }
        },
        enable_rbac_authorization: {
          client_side_validation: true,
          required: false,
          serialized_name: 'enableRbacAuthorization',
          default_value: false,
          type: {
            name: 'Boolean'
          }
        },
        create_mode: {
          client_side_validation: true,
          required: false,
          serialized_name: 'createMode',
          type: {
            name: 'Enum',
            module: 'CreateMode'
          }
        },
        enable_purge_protection: {
          client_side_validation: true,
          required: false,
          serialized_name: 'enablePurgeProtection',
          type: {
            name: 'Boolean'
          }
        },
        network_acls: {
          client_side_validation: true,
          required: false,
          serialized_name: 'networkAcls',
          type: {
            name: 'Composite',
            class_name: 'NetworkRuleSet'
          }
        },
        private_endpoint_connections: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'privateEndpointConnections',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'PrivateEndpointConnectionItemElementType',
                type: {
                  name: 'Composite',
                  class_name: 'PrivateEndpointConnectionItem'
                }
            }
          }
        }
      }
    }
  }
end