Skip to content

RotatedSecretCreateAzure.md

Latest commit

 

History

History
120 lines (114 loc) · 8.19 KB

RotatedSecretCreateAzure.md

File metadata and controls

120 lines (114 loc) · 8.19 KB
Raw

Akeyless::RotatedSecretCreateAzure

Properties

Name Type Description Notes
api_id String API ID to rotate (relevant only for rotator-type=api-key) [optional]
api_key String API key to rotate (relevant only for rotator-type=api-key) [optional]
application_id String Id of the azure app that hold the serect to be rotated (relevant only for rotator-type=api-key & authentication-credentials=use-target-creds) [optional]
ara_enabled Boolean Enable or disable Agentic Runtime Authority rule enforcement for this item. When false, user-defined input/output rules are stored but not enforced; the base security validation still runs. AraEnabled is tri-state (nil/true/false), not a plain bool: it self-encodes its wire value (see akl.OptionalBool) so an explicit false survives the curl-proxy relay instead of being dropped like a default-false bool flag. [optional]
authentication_credentials String The credentials to connect with use-user-creds/use-target-creds [optional][default to 'use-user-creds']
auto_rotate String [optional]
delete_protection String Protection from accidental deletion of this object [true/false] [optional]
description String Description of the object [optional]
enable_agentic_runtime_authority Boolean EnableAra is the documented spelling of AraEnabled. Both set the same field; --ara-enabled shipped first and stays as an undocumented alias so existing scripts and the Terraform provider keep working. [optional]
enable_ai_quorum Boolean Turns on AI Quorum checks for this item. [optional]
explicitly_set_sa String If set, explicitly provide the storage account details [true/false] [optional][default to 'false']
grace_rotation String Enable graceful rotation (keep both versions temporarily). When enabled, a new secret version is created while the previous version is kept for the grace period, so both versions exist for a limited time. [true/false] [optional]
grace_rotation_hour Integer The Hour of the grace rotation in UTC [optional]
grace_rotation_interval String The number of days to wait before deleting the old key (must be bigger than rotation-interval) [optional]
grace_rotation_timing String When to create the new version relative to the rotation date [after/before] [optional]
input_rule Array<String> Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) [optional]
item_custom_fields Hash<String, String> Additional custom fields to associate with the item [optional]
json Boolean Set output format to JSON [optional][default to false]
key String [optional]
lock_during_sra_session String Lock this secret for read/update while an SRA session is active [optional]
lock_on_read String Lock this secret after each successful value read [optional]
lock_ttl String Lock TTL in minutes [optional]
max_versions String Set the maximum number of versions, limited by the account settings defaults. [optional]
name String Rotated secret name
output_rule Array<String> Agentic output rule in name=...,rule=... format (e.g. name=rule1,rule=Mask secrets) [optional]
password String The password for the user principal name to rotate (relevant only for rotator-type=password) [optional]
password_length String The length of the password to be generated [optional]
resource_group_name String The resource group name (only relevant when explicitly-set-sa=true) [optional]
resource_name String The name of the storage account (only relevant when explicitly-set-sa=true) [optional]
rotate_after_disconnect String StringOrBool accepts JSON strings, booleans, and numbers for backward compatibility with older SDK versions that send boolean values for rotate-after-disconnect. [optional]
rotate_on_unlock String Rotate this secret after it is unlocked [optional]
rotation_event_in Array<String> How many days before the rotation of the item would you like to be notified [optional]
rotation_hour Integer [optional]
rotation_interval String [optional]
rotator_type String The rotator type. options: [target/password/api-key/azure-storage-account]
secure_access_disable_concurrent_connections Boolean Enable this flag to prevent simultaneous use of the same secret [optional]
secure_access_enable String Enable/Disable secure remote access [true/false] [optional]
secure_access_url String Destination URL to inject secrets [optional]
secure_access_web Boolean Enable Web Secure Remote Access [optional][default to false]
secure_access_web_browsing Boolean Secure browser via Akeyless's Secure Remote Access (SRA) [optional][default to false]
secure_access_web_proxy Boolean Web-Proxy via Akeyless's Secure Remote Access (SRA) [optional][default to false]
skip_dry_run String If set, dry-run will be skipped [optional]
storage_account_key_name String The name of the storage account key to rotate [key1/key2/kerb1/kerb2] (relevat to azure-storage-account) [optional]
tags Array<String> Add tags attached to this object [optional]
target_name String The target name to associate
token String Authentication token (see `/auth` and `/configure`) [optional]
uid_token String The universal identity token, Required only for universal_identity authentication [optional]
use_capital_letters String Specifies whether the generated temporary password must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z). [true/false] [optional]
use_lower_letters String Specifies whether the generated temporary password must contain at least one lowercase character from the ISO basic Latin alphabet (a to z). [true/false] [optional]
use_numbers String Specifies whether the generated temporary password must contain at least one numeric character (0 to 9). [true/false] [optional]
use_special_characters String [optional]
username String The user principal name to rotate his password (relevant only for rotator-type=password) [optional]

Example

require 'akeyless'

instance = Akeyless::RotatedSecretCreateAzure.new(
  api_id: null,
  api_key: null,
  application_id: null,
  ara_enabled: null,
  authentication_credentials: null,
  auto_rotate: null,
  delete_protection: null,
  description: null,
  enable_agentic_runtime_authority: null,
  enable_ai_quorum: null,
  explicitly_set_sa: null,
  grace_rotation: null,
  grace_rotation_hour: null,
  grace_rotation_interval: null,
  grace_rotation_timing: null,
  input_rule: null,
  item_custom_fields: null,
  json: null,
  key: null,
  lock_during_sra_session: null,
  lock_on_read: null,
  lock_ttl: null,
  max_versions: null,
  name: null,
  output_rule: null,
  password: null,
  password_length: null,
  resource_group_name: null,
  resource_name: null,
  rotate_after_disconnect: null,
  rotate_on_unlock: null,
  rotation_event_in: null,
  rotation_hour: null,
  rotation_interval: null,
  rotator_type: null,
  secure_access_disable_concurrent_connections: null,
  secure_access_enable: null,
  secure_access_url: null,
  secure_access_web: null,
  secure_access_web_browsing: null,
  secure_access_web_proxy: null,
  skip_dry_run: null,
  storage_account_key_name: null,
  tags: null,
  target_name: null,
  token: null,
  uid_token: null,
  use_capital_letters: null,
  use_lower_letters: null,
  use_numbers: null,
  use_special_characters: ! @ # $. [true/false],
  username: null
)