From 6a6c0e6fce41275c709e8da351b0b45f2c9ba256 Mon Sep 17 00:00:00 2001 From: Azure SDK for Python bot Date: Mon, 3 Dec 2018 08:10:23 -0800 Subject: [PATCH 1/2] Generated from 062256ec3137eb264c9f6938d199f94af2543c14 (#4272) typo: resource-manager/Microsoft.KeyVault - Double word "the" - availabity -> availability - accesibility -> accessibility - Decription -> Description --- lib/services/keyVaultManagement/LICENSE.txt | 42 +- .../lib/models/accessPolicyEntry.js | 18 +- .../lib/models/checkNameAvailabilityResult.js | 12 +- .../lib/models/deletedVault.js | 20 +- .../lib/models/deletedVaultListResult.js | 3 +- .../lib/models/deletedVaultProperties.js | 10 +- .../keyVaultManagement/lib/models/iPRule.js | 4 +- .../keyVaultManagement/lib/models/index.d.ts | 748 +++++++----------- .../lib/models/logSpecification.js | 6 +- .../lib/models/networkRuleSet.js | 8 +- .../lib/models/operation.js | 25 +- .../lib/models/operationDisplay.js | 8 +- .../lib/models/operationListResult.js | 2 +- .../lib/models/permissions.js | 8 +- .../keyVaultManagement/lib/models/resource.js | 12 +- .../lib/models/resourceListResult.js | 2 +- .../lib/models/serviceSpecification.js | 2 +- .../keyVaultManagement/lib/models/sku.js | 2 +- .../keyVaultManagement/lib/models/vault.js | 50 +- .../lib/models/vaultAccessPolicyParameters.js | 16 +- .../lib/models/vaultAccessPolicyProperties.js | 2 +- .../vaultCheckNameAvailabilityParameters.js | 4 +- .../models/vaultCreateOrUpdateParameters.js | 56 +- .../lib/models/vaultListResult.js | 2 +- .../lib/models/vaultPatchParameters.js | 48 +- .../lib/models/vaultPatchProperties.js | 50 +- .../lib/models/vaultProperties.js | 52 +- .../lib/models/virtualNetworkRule.js | 4 +- lib/services/keyVaultManagement/package.json | 2 +- 29 files changed, 533 insertions(+), 685 deletions(-) diff --git a/lib/services/keyVaultManagement/LICENSE.txt b/lib/services/keyVaultManagement/LICENSE.txt index a70e8cf660..5431ba98b9 100644 --- a/lib/services/keyVaultManagement/LICENSE.txt +++ b/lib/services/keyVaultManagement/LICENSE.txt @@ -1,21 +1,21 @@ -The MIT License (MIT) - -Copyright (c) 2018 Microsoft - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +The MIT License (MIT) + +Copyright (c) 2018 Microsoft + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/lib/services/keyVaultManagement/lib/models/accessPolicyEntry.js b/lib/services/keyVaultManagement/lib/models/accessPolicyEntry.js index 69e87b4a5c..c134a64483 100755 --- a/lib/services/keyVaultManagement/lib/models/accessPolicyEntry.js +++ b/lib/services/keyVaultManagement/lib/models/accessPolicyEntry.js @@ -18,19 +18,19 @@ class AccessPolicyEntry { /** * Create a AccessPolicyEntry. - * @member {uuid} tenantId The Azure Active Directory tenant ID that should + * @property {uuid} tenantId The Azure Active Directory tenant ID that should * be used for authenticating requests to the key vault. - * @member {string} objectId The object ID of a user, service principal or + * @property {string} objectId The object ID of a user, service principal or * security group in the Azure Active Directory tenant for the vault. The * object ID must be unique for the list of access policies. - * @member {uuid} [applicationId] Application ID of the client making request - * on behalf of a principal - * @member {object} permissions Permissions the identity has for keys, + * @property {uuid} [applicationId] Application ID of the client making + * request on behalf of a principal + * @property {object} permissions Permissions the identity has for keys, * secrets and certificates. - * @member {array} [permissions.keys] Permissions to keys - * @member {array} [permissions.secrets] Permissions to secrets - * @member {array} [permissions.certificates] Permissions to certificates - * @member {array} [permissions.storage] Permissions to storage accounts + * @property {array} [permissions.keys] Permissions to keys + * @property {array} [permissions.secrets] Permissions to secrets + * @property {array} [permissions.certificates] Permissions to certificates + * @property {array} [permissions.storage] Permissions to storage accounts */ constructor() { } diff --git a/lib/services/keyVaultManagement/lib/models/checkNameAvailabilityResult.js b/lib/services/keyVaultManagement/lib/models/checkNameAvailabilityResult.js index f6b1d65f94..3fa22cf18e 100644 --- a/lib/services/keyVaultManagement/lib/models/checkNameAvailabilityResult.js +++ b/lib/services/keyVaultManagement/lib/models/checkNameAvailabilityResult.js @@ -17,14 +17,14 @@ class CheckNameAvailabilityResult { /** * Create a CheckNameAvailabilityResult. - * @member {boolean} [nameAvailable] A boolean value that indicates whether + * @property {boolean} [nameAvailable] A boolean value that indicates whether * the name is available for you to use. If true, the name is available. If * false, the name has already been taken or is invalid and cannot be used. - * @member {string} [reason] The reason that a vault name could not be used. - * The Reason element is only returned if NameAvailable is false. Possible - * values include: 'AccountNameInvalid', 'AlreadyExists' - * @member {string} [message] An error message explaining the Reason value in - * more detail. + * @property {string} [reason] The reason that a vault name could not be + * used. The Reason element is only returned if NameAvailable is false. + * Possible values include: 'AccountNameInvalid', 'AlreadyExists' + * @property {string} [message] An error message explaining the Reason value + * in more detail. */ constructor() { } diff --git a/lib/services/keyVaultManagement/lib/models/deletedVault.js b/lib/services/keyVaultManagement/lib/models/deletedVault.js index 8e56a9fc42..4fc4dd1be7 100644 --- a/lib/services/keyVaultManagement/lib/models/deletedVault.js +++ b/lib/services/keyVaultManagement/lib/models/deletedVault.js @@ -17,16 +17,18 @@ class DeletedVault { /** * Create a DeletedVault. - * @member {string} [id] The resource ID for the deleted key vault. - * @member {string} [name] The name of the key vault. - * @member {string} [type] The resource type of the key vault. - * @member {object} [properties] Properties of the vault - * @member {string} [properties.vaultId] The resource id of the original + * @property {string} [id] The resource ID for the deleted key vault. + * @property {string} [name] The name of the key vault. + * @property {string} [type] The resource type of the key vault. + * @property {object} [properties] Properties of the vault + * @property {string} [properties.vaultId] The resource id of the original * vault. - * @member {string} [properties.location] The location of the original vault. - * @member {date} [properties.deletionDate] The deleted date. - * @member {date} [properties.scheduledPurgeDate] The scheduled purged date. - * @member {object} [properties.tags] Tags of the original vault. + * @property {string} [properties.location] The location of the original + * vault. + * @property {date} [properties.deletionDate] The deleted date. + * @property {date} [properties.scheduledPurgeDate] The scheduled purged + * date. + * @property {object} [properties.tags] Tags of the original vault. */ constructor() { } diff --git a/lib/services/keyVaultManagement/lib/models/deletedVaultListResult.js b/lib/services/keyVaultManagement/lib/models/deletedVaultListResult.js index 42b5c4092e..fcf8ed5a50 100644 --- a/lib/services/keyVaultManagement/lib/models/deletedVaultListResult.js +++ b/lib/services/keyVaultManagement/lib/models/deletedVaultListResult.js @@ -16,7 +16,8 @@ class DeletedVaultListResult extends Array { /** * Create a DeletedVaultListResult. - * @member {string} [nextLink] The URL to get the next set of deleted vaults. + * @property {string} [nextLink] The URL to get the next set of deleted + * vaults. */ constructor() { super(); diff --git a/lib/services/keyVaultManagement/lib/models/deletedVaultProperties.js b/lib/services/keyVaultManagement/lib/models/deletedVaultProperties.js index 7dab4539e4..17902c2826 100644 --- a/lib/services/keyVaultManagement/lib/models/deletedVaultProperties.js +++ b/lib/services/keyVaultManagement/lib/models/deletedVaultProperties.js @@ -17,11 +17,11 @@ class DeletedVaultProperties { /** * Create a DeletedVaultProperties. - * @member {string} [vaultId] The resource id of the original vault. - * @member {string} [location] The location of the original vault. - * @member {date} [deletionDate] The deleted date. - * @member {date} [scheduledPurgeDate] The scheduled purged date. - * @member {object} [tags] Tags of the original vault. + * @property {string} [vaultId] The resource id of the original vault. + * @property {string} [location] The location of the original vault. + * @property {date} [deletionDate] The deleted date. + * @property {date} [scheduledPurgeDate] The scheduled purged date. + * @property {object} [tags] Tags of the original vault. */ constructor() { } diff --git a/lib/services/keyVaultManagement/lib/models/iPRule.js b/lib/services/keyVaultManagement/lib/models/iPRule.js index 892a6046b1..0505cf3d8b 100644 --- a/lib/services/keyVaultManagement/lib/models/iPRule.js +++ b/lib/services/keyVaultManagement/lib/models/iPRule.js @@ -11,14 +11,14 @@ 'use strict'; /** - * A rule governing the accesibility of a vault from a specific ip address or + * A rule governing the accessibility of a vault from a specific ip address or * ip range. * */ class IPRule { /** * Create a IPRule. - * @member {string} value An IPv4 address range in CIDR notation, such as + * @property {string} value An IPv4 address range in CIDR notation, such as * '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that * start with 124.56.78). */ diff --git a/lib/services/keyVaultManagement/lib/models/index.d.ts b/lib/services/keyVaultManagement/lib/models/index.d.ts index 85719e36e8..3c79b3e6bb 100755 --- a/lib/services/keyVaultManagement/lib/models/index.d.ts +++ b/lib/services/keyVaultManagement/lib/models/index.d.ts @@ -1,694 +1,536 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ -import { BaseResource } from 'ms-rest-azure'; -import { CloudError } from 'ms-rest-azure'; -import * as moment from 'moment'; +import { BaseResource, CloudError } from "ms-rest-azure"; +import * as moment from "moment"; -export { BaseResource } from 'ms-rest-azure'; -export { CloudError } from 'ms-rest-azure'; +export { + BaseResource, + CloudError +}; /** - * @class - * Initializes a new instance of the Sku class. - * @constructor * SKU details - * - * @member {string} name SKU name to specify whether the key vault is a - * standard vault or a premium vault. Possible values include: 'standard', - * 'premium' */ export interface Sku { + /** + * SKU name to specify whether the key vault is a standard vault or a premium vault. Possible + * values include: 'standard', 'premium' + */ name: string; } /** - * @class - * Initializes a new instance of the Permissions class. - * @constructor * Permissions the identity has for keys, secrets, certificates and storage. - * - * @member {array} [keys] Permissions to keys - * @member {array} [secrets] Permissions to secrets - * @member {array} [certificates] Permissions to certificates - * @member {array} [storage] Permissions to storage accounts */ export interface Permissions { + /** + * Permissions to keys + */ keys?: string[]; + /** + * Permissions to secrets + */ secrets?: string[]; + /** + * Permissions to certificates + */ certificates?: string[]; + /** + * Permissions to storage accounts + */ storage?: string[]; } /** - * @class - * Initializes a new instance of the AccessPolicyEntry class. - * @constructor - * An identity 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. - * - * @member {uuid} tenantId The Azure Active Directory tenant ID that should be - * used for authenticating requests to the key vault. - * @member {string} objectId The object ID of a user, service principal or - * security group in the Azure Active Directory tenant for the vault. The - * object ID must be unique for the list of access policies. - * @member {uuid} [applicationId] Application ID of the client making request - * on behalf of a principal - * @member {object} permissions Permissions the identity has for keys, secrets - * and certificates. - * @member {array} [permissions.keys] Permissions to keys - * @member {array} [permissions.secrets] Permissions to secrets - * @member {array} [permissions.certificates] Permissions to certificates - * @member {array} [permissions.storage] Permissions to storage accounts + * An identity 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. */ export interface AccessPolicyEntry { + /** + * The Azure Active Directory tenant ID that should be used for authenticating requests to the + * key vault. + */ tenantId: string; + /** + * The object ID of a user, service principal or security group in the Azure Active Directory + * tenant for the vault. The object ID must be unique for the list of access policies. + */ objectId: string; + /** + * Application ID of the client making request on behalf of a principal + */ applicationId?: string; + /** + * Permissions the identity has for keys, secrets and certificates. + */ permissions: Permissions; } /** - * @class - * Initializes a new instance of the IPRule class. - * @constructor - * A rule governing the accesibility of a vault from a specific ip address or - * ip range. - * - * @member {string} value An IPv4 address range in CIDR notation, such as - * '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that - * start with 124.56.78). + * A rule governing the accessibility of a vault from a specific ip address or ip range. */ export interface IPRule { + /** + * An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or + * '124.56.78.0/24' (all addresses that start with 124.56.78). + */ value: string; } /** - * @class - * Initializes a new instance of the VirtualNetworkRule class. - * @constructor - * A rule governing the accesibility of a vault from a specific virtual - * network. - * - * @member {string} id Full resource id of a vnet subnet, such as - * '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. + * A rule governing the accessibility of a vault from a specific virtual network. */ export interface VirtualNetworkRule { + /** + * Full resource id of a vnet subnet, such as + * '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. + */ id: string; } /** - * @class - * Initializes a new instance of the NetworkRuleSet class. - * @constructor * A set of rules governing the network accessibility of a vault. - * - * @member {string} [bypass] Tells what traffic can bypass network rules. This - * can be 'AzureServices' or 'None'. If not specified the default is - * 'AzureServices'. Possible values include: 'AzureServices', 'None' - * @member {string} [defaultAction] The default action when no rule from - * ipRules and from virtualNetworkRules match. This is only used after the - * bypass property has been evaluated. Possible values include: 'Allow', 'Deny' - * @member {array} [ipRules] The list of IP address rules. - * @member {array} [virtualNetworkRules] The list of virtual network rules. */ export interface NetworkRuleSet { + /** + * Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not + * specified the default is 'AzureServices'. Possible values include: 'AzureServices', 'None' + */ bypass?: string; + /** + * The default action when no rule from ipRules and from virtualNetworkRules match. This is only + * used after the bypass property has been evaluated. Possible values include: 'Allow', 'Deny' + */ defaultAction?: string; + /** + * The list of IP address rules. + */ ipRules?: IPRule[]; + /** + * The list of virtual network rules. + */ virtualNetworkRules?: VirtualNetworkRule[]; } /** - * @class - * Initializes a new instance of the VaultProperties class. - * @constructor * Properties of the vault - * - * @member {uuid} tenantId The Azure Active Directory tenant ID that should be - * used for authenticating requests to the key vault. - * @member {object} sku SKU details - * @member {string} [sku.name] SKU name to specify whether the key vault is a - * standard vault or a premium vault. Possible values include: 'standard', - * 'premium' - * @member {array} [accessPolicies] An array of 0 to 16 identities 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. - * @member {string} [vaultUri] The URI of the vault for performing operations - * on keys and secrets. - * @member {boolean} [enabledForDeployment] Property to specify whether Azure - * Virtual Machines are permitted to retrieve certificates stored as secrets - * from the key vault. - * @member {boolean} [enabledForDiskEncryption] Property to specify whether - * Azure Disk Encryption is permitted to retrieve secrets from the vault and - * unwrap keys. - * @member {boolean} [enabledForTemplateDeployment] Property to specify whether - * Azure Resource Manager is permitted to retrieve secrets from the key vault. - * @member {boolean} [enableSoftDelete] Property to specify whether the 'soft - * delete' functionality is enabled for this key vault. It does not accept - * false value. - * @member {string} [createMode] The vault's create mode to indicate whether - * the vault need to be recovered or not. Possible values include: 'recover', - * 'default' - * @member {boolean} [enablePurgeProtection] Property specifying whether - * protection against purge 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. - * @member {object} [networkAcls] A collection of rules governing the - * accessibility of the vault from specific network locations. - * @member {string} [networkAcls.bypass] Tells what traffic can bypass network - * rules. This can be 'AzureServices' or 'None'. If not specified the default - * is 'AzureServices'. Possible values include: 'AzureServices', 'None' - * @member {string} [networkAcls.defaultAction] The default action when no rule - * from ipRules and from virtualNetworkRules match. This is only used after the - * bypass property has been evaluated. Possible values include: 'Allow', 'Deny' - * @member {array} [networkAcls.ipRules] The list of IP address rules. - * @member {array} [networkAcls.virtualNetworkRules] The list of virtual - * network rules. */ export interface VaultProperties { + /** + * The Azure Active Directory tenant ID that should be used for authenticating requests to the + * key vault. + */ tenantId: string; + /** + * SKU details + */ sku: Sku; + /** + * An array of 0 to 16 identities 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. + */ accessPolicies?: AccessPolicyEntry[]; + /** + * The URI of the vault for performing operations on keys and secrets. + */ vaultUri?: string; + /** + * Property to specify whether Azure Virtual Machines are permitted to retrieve certificates + * stored as secrets from the key vault. + */ enabledForDeployment?: boolean; + /** + * Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the + * vault and unwrap keys. + */ enabledForDiskEncryption?: boolean; + /** + * Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the + * key vault. + */ enabledForTemplateDeployment?: boolean; + /** + * Property to specify whether the 'soft delete' functionality is enabled for this key vault. It + * does not accept false value. + */ enableSoftDelete?: boolean; + /** + * The vault's create mode to indicate whether the vault need to be recovered or not. Possible + * values include: 'recover', 'default' + */ createMode?: string; + /** + * Property specifying whether protection against purge 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. + */ enablePurgeProtection?: boolean; + /** + * A collection of rules governing the accessibility of the vault from specific network + * locations. + */ networkAcls?: NetworkRuleSet; } /** - * @class - * Initializes a new instance of the VaultPatchProperties class. - * @constructor * Properties of the vault - * - * @member {uuid} [tenantId] The Azure Active Directory tenant ID that should - * be used for authenticating requests to the key vault. - * @member {object} [sku] SKU details - * @member {string} [sku.name] SKU name to specify whether the key vault is a - * standard vault or a premium vault. Possible values include: 'standard', - * 'premium' - * @member {array} [accessPolicies] An array of 0 to 16 identities 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. - * @member {boolean} [enabledForDeployment] Property to specify whether Azure - * Virtual Machines are permitted to retrieve certificates stored as secrets - * from the key vault. - * @member {boolean} [enabledForDiskEncryption] Property to specify whether - * Azure Disk Encryption is permitted to retrieve secrets from the vault and - * unwrap keys. - * @member {boolean} [enabledForTemplateDeployment] Property to specify whether - * Azure Resource Manager is permitted to retrieve secrets from the key vault. - * @member {boolean} [enableSoftDelete] Property to specify whether the 'soft - * delete' functionality is enabled for this key vault. It does not accept - * false value. - * @member {string} [createMode] The vault's create mode to indicate whether - * the vault need to be recovered or not. Possible values include: 'recover', - * 'default' - * @member {boolean} [enablePurgeProtection] Property specifying whether - * protection against purge 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. - * @member {object} [networkAcls] A collection of rules governing the - * accessibility of the vault from specific network locations. - * @member {string} [networkAcls.bypass] Tells what traffic can bypass network - * rules. This can be 'AzureServices' or 'None'. If not specified the default - * is 'AzureServices'. Possible values include: 'AzureServices', 'None' - * @member {string} [networkAcls.defaultAction] The default action when no rule - * from ipRules and from virtualNetworkRules match. This is only used after the - * bypass property has been evaluated. Possible values include: 'Allow', 'Deny' - * @member {array} [networkAcls.ipRules] The list of IP address rules. - * @member {array} [networkAcls.virtualNetworkRules] The list of virtual - * network rules. */ export interface VaultPatchProperties { + /** + * The Azure Active Directory tenant ID that should be used for authenticating requests to the + * key vault. + */ tenantId?: string; + /** + * SKU details + */ sku?: Sku; + /** + * An array of 0 to 16 identities 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. + */ accessPolicies?: AccessPolicyEntry[]; + /** + * Property to specify whether Azure Virtual Machines are permitted to retrieve certificates + * stored as secrets from the key vault. + */ enabledForDeployment?: boolean; + /** + * Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the + * vault and unwrap keys. + */ enabledForDiskEncryption?: boolean; + /** + * Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the + * key vault. + */ enabledForTemplateDeployment?: boolean; + /** + * Property to specify whether the 'soft delete' functionality is enabled for this key vault. It + * does not accept false value. + */ enableSoftDelete?: boolean; + /** + * The vault's create mode to indicate whether the vault need to be recovered or not. Possible + * values include: 'recover', 'default' + */ createMode?: string; + /** + * Property specifying whether protection against purge 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. + */ enablePurgeProtection?: boolean; + /** + * A collection of rules governing the accessibility of the vault from specific network + * locations. + */ networkAcls?: NetworkRuleSet; } /** - * @class - * Initializes a new instance of the VaultAccessPolicyProperties class. - * @constructor * Properties of the vault access policy - * - * @member {array} accessPolicies An array of 0 to 16 identities 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. */ export interface VaultAccessPolicyProperties { + /** + * An array of 0 to 16 identities 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. + */ accessPolicies: AccessPolicyEntry[]; } /** - * @class - * Initializes a new instance of the DeletedVaultProperties class. - * @constructor * Properties of the deleted vault. - * - * @member {string} [vaultId] The resource id of the original vault. - * @member {string} [location] The location of the original vault. - * @member {date} [deletionDate] The deleted date. - * @member {date} [scheduledPurgeDate] The scheduled purged date. - * @member {object} [tags] Tags of the original vault. */ export interface DeletedVaultProperties { + /** + * The resource id of the original vault. + */ readonly vaultId?: string; + /** + * The location of the original vault. + */ readonly location?: string; + /** + * The deleted date. + */ readonly deletionDate?: Date; + /** + * The scheduled purged date. + */ readonly scheduledPurgeDate?: Date; + /** + * Tags of the original vault. + */ readonly tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the VaultCreateOrUpdateParameters class. - * @constructor * Parameters for creating or updating a vault - * - * @member {string} location The supported Azure location where the key vault - * should be created. - * @member {object} [tags] The tags that will be assigned to the key vault. - * @member {object} properties Properties of the vault - * @member {uuid} [properties.tenantId] The Azure Active Directory tenant ID - * that should be used for authenticating requests to the key vault. - * @member {object} [properties.sku] SKU details - * @member {string} [properties.sku.name] SKU name to specify whether the key - * vault is a standard vault or a premium vault. Possible values include: - * 'standard', 'premium' - * @member {array} [properties.accessPolicies] An array of 0 to 16 identities - * 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. - * @member {string} [properties.vaultUri] The URI of the vault for performing - * operations on keys and secrets. - * @member {boolean} [properties.enabledForDeployment] Property to specify - * whether Azure Virtual Machines are permitted to retrieve certificates stored - * as secrets from the key vault. - * @member {boolean} [properties.enabledForDiskEncryption] Property to specify - * whether Azure Disk Encryption is permitted to retrieve secrets from the - * vault and unwrap keys. - * @member {boolean} [properties.enabledForTemplateDeployment] Property to - * specify whether Azure Resource Manager is permitted to retrieve secrets from - * the key vault. - * @member {boolean} [properties.enableSoftDelete] Property to specify whether - * the 'soft delete' functionality is enabled for this key vault. It does not - * accept false value. - * @member {string} [properties.createMode] The vault's create mode to indicate - * whether the vault need to be recovered or not. Possible values include: - * 'recover', 'default' - * @member {boolean} [properties.enablePurgeProtection] Property specifying - * whether protection against purge 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. - * @member {object} [properties.networkAcls] A collection of rules governing - * the accessibility of the vault from specific network locations. - * @member {string} [properties.networkAcls.bypass] Tells what traffic can - * bypass network rules. This can be 'AzureServices' or 'None'. If not - * specified the default is 'AzureServices'. Possible values include: - * 'AzureServices', 'None' - * @member {string} [properties.networkAcls.defaultAction] The default action - * when no rule from ipRules and from virtualNetworkRules match. This is only - * used after the bypass property has been evaluated. Possible values include: - * 'Allow', 'Deny' - * @member {array} [properties.networkAcls.ipRules] The list of IP address - * rules. - * @member {array} [properties.networkAcls.virtualNetworkRules] The list of - * virtual network rules. */ export interface VaultCreateOrUpdateParameters extends BaseResource { + /** + * The supported Azure location where the key vault should be created. + */ location: string; + /** + * The tags that will be assigned to the key vault. + */ tags?: { [propertyName: string]: string }; + /** + * Properties of the vault + */ properties: VaultProperties; } /** - * @class - * Initializes a new instance of the VaultPatchParameters class. - * @constructor * Parameters for creating or updating a vault - * - * @member {object} [tags] The tags that will be assigned to the key vault. - * @member {object} [properties] Properties of the vault - * @member {uuid} [properties.tenantId] The Azure Active Directory tenant ID - * that should be used for authenticating requests to the key vault. - * @member {object} [properties.sku] SKU details - * @member {string} [properties.sku.name] SKU name to specify whether the key - * vault is a standard vault or a premium vault. Possible values include: - * 'standard', 'premium' - * @member {array} [properties.accessPolicies] An array of 0 to 16 identities - * 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. - * @member {boolean} [properties.enabledForDeployment] Property to specify - * whether Azure Virtual Machines are permitted to retrieve certificates stored - * as secrets from the key vault. - * @member {boolean} [properties.enabledForDiskEncryption] Property to specify - * whether Azure Disk Encryption is permitted to retrieve secrets from the - * vault and unwrap keys. - * @member {boolean} [properties.enabledForTemplateDeployment] Property to - * specify whether Azure Resource Manager is permitted to retrieve secrets from - * the key vault. - * @member {boolean} [properties.enableSoftDelete] Property to specify whether - * the 'soft delete' functionality is enabled for this key vault. It does not - * accept false value. - * @member {string} [properties.createMode] The vault's create mode to indicate - * whether the vault need to be recovered or not. Possible values include: - * 'recover', 'default' - * @member {boolean} [properties.enablePurgeProtection] Property specifying - * whether protection against purge 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. - * @member {object} [properties.networkAcls] A collection of rules governing - * the accessibility of the vault from specific network locations. - * @member {string} [properties.networkAcls.bypass] Tells what traffic can - * bypass network rules. This can be 'AzureServices' or 'None'. If not - * specified the default is 'AzureServices'. Possible values include: - * 'AzureServices', 'None' - * @member {string} [properties.networkAcls.defaultAction] The default action - * when no rule from ipRules and from virtualNetworkRules match. This is only - * used after the bypass property has been evaluated. Possible values include: - * 'Allow', 'Deny' - * @member {array} [properties.networkAcls.ipRules] The list of IP address - * rules. - * @member {array} [properties.networkAcls.virtualNetworkRules] The list of - * virtual network rules. */ export interface VaultPatchParameters extends BaseResource { + /** + * The tags that will be assigned to the key vault. + */ tags?: { [propertyName: string]: string }; + /** + * Properties of the vault + */ properties?: VaultPatchProperties; } /** - * @class - * Initializes a new instance of the VaultAccessPolicyParameters class. - * @constructor * Parameters for updating the access policy in a vault - * - * @member {string} [id] The resource id of the access policy. - * @member {string} [name] The resource name of the access policy. - * @member {string} [type] The resource name of the access policy. - * @member {string} [location] The resource type of the the access policy. - * @member {object} properties Properties of the access policy - * @member {array} [properties.accessPolicies] An array of 0 to 16 identities - * 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. */ export interface VaultAccessPolicyParameters extends BaseResource { + /** + * The resource id of the access policy. + */ readonly id?: string; + /** + * The resource name of the access policy. + */ readonly name?: string; + /** + * The resource name of the access policy. + */ readonly type?: string; + /** + * The resource type of the access policy. + */ readonly location?: string; + /** + * Properties of the access policy + */ properties: VaultAccessPolicyProperties; } /** - * @class - * Initializes a new instance of the Resource class. - * @constructor * Key Vault resource - * - * @member {string} [id] The Azure Resource Manager resource ID for the key - * vault. - * @member {string} [name] The name of the key vault. - * @member {string} [type] The resource type of the key vault. - * @member {string} location The supported Azure location where the key vault - * should be created. - * @member {object} [tags] The tags that will be assigned to the key vault. */ export interface Resource extends BaseResource { + /** + * The Azure Resource Manager resource ID for the key vault. + */ readonly id?: string; + /** + * The name of the key vault. + */ readonly name?: string; + /** + * The resource type of the key vault. + */ readonly type?: string; + /** + * The supported Azure location where the key vault should be created. + */ location: string; + /** + * The tags that will be assigned to the key vault. + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the Vault class. - * @constructor * Resource information with extended details. - * - * @member {object} properties Properties of the vault - * @member {uuid} [properties.tenantId] The Azure Active Directory tenant ID - * that should be used for authenticating requests to the key vault. - * @member {object} [properties.sku] SKU details - * @member {string} [properties.sku.name] SKU name to specify whether the key - * vault is a standard vault or a premium vault. Possible values include: - * 'standard', 'premium' - * @member {array} [properties.accessPolicies] An array of 0 to 16 identities - * 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. - * @member {string} [properties.vaultUri] The URI of the vault for performing - * operations on keys and secrets. - * @member {boolean} [properties.enabledForDeployment] Property to specify - * whether Azure Virtual Machines are permitted to retrieve certificates stored - * as secrets from the key vault. - * @member {boolean} [properties.enabledForDiskEncryption] Property to specify - * whether Azure Disk Encryption is permitted to retrieve secrets from the - * vault and unwrap keys. - * @member {boolean} [properties.enabledForTemplateDeployment] Property to - * specify whether Azure Resource Manager is permitted to retrieve secrets from - * the key vault. - * @member {boolean} [properties.enableSoftDelete] Property to specify whether - * the 'soft delete' functionality is enabled for this key vault. It does not - * accept false value. - * @member {string} [properties.createMode] The vault's create mode to indicate - * whether the vault need to be recovered or not. Possible values include: - * 'recover', 'default' - * @member {boolean} [properties.enablePurgeProtection] Property specifying - * whether protection against purge 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. - * @member {object} [properties.networkAcls] A collection of rules governing - * the accessibility of the vault from specific network locations. - * @member {string} [properties.networkAcls.bypass] Tells what traffic can - * bypass network rules. This can be 'AzureServices' or 'None'. If not - * specified the default is 'AzureServices'. Possible values include: - * 'AzureServices', 'None' - * @member {string} [properties.networkAcls.defaultAction] The default action - * when no rule from ipRules and from virtualNetworkRules match. This is only - * used after the bypass property has been evaluated. Possible values include: - * 'Allow', 'Deny' - * @member {array} [properties.networkAcls.ipRules] The list of IP address - * rules. - * @member {array} [properties.networkAcls.virtualNetworkRules] The list of - * virtual network rules. */ export interface Vault extends Resource { + /** + * Properties of the vault + */ properties: VaultProperties; } /** - * @class - * Initializes a new instance of the DeletedVault class. - * @constructor * Deleted vault information with extended details. - * - * @member {string} [id] The resource ID for the deleted key vault. - * @member {string} [name] The name of the key vault. - * @member {string} [type] The resource type of the key vault. - * @member {object} [properties] Properties of the vault - * @member {string} [properties.vaultId] The resource id of the original vault. - * @member {string} [properties.location] The location of the original vault. - * @member {date} [properties.deletionDate] The deleted date. - * @member {date} [properties.scheduledPurgeDate] The scheduled purged date. - * @member {object} [properties.tags] Tags of the original vault. */ export interface DeletedVault { + /** + * The resource ID for the deleted key vault. + */ readonly id?: string; + /** + * The name of the key vault. + */ readonly name?: string; + /** + * The resource type of the key vault. + */ readonly type?: string; + /** + * Properties of the vault + */ properties?: DeletedVaultProperties; } /** - * @class - * Initializes a new instance of the VaultCheckNameAvailabilityParameters class. - * @constructor - * The parameters used to check the availabity of the vault name. - * - * @member {string} name The vault name. + * The parameters used to check the availability of the vault name. */ export interface VaultCheckNameAvailabilityParameters { + /** + * The vault name. + */ name: string; } /** - * @class - * Initializes a new instance of the CheckNameAvailabilityResult class. - * @constructor * The CheckNameAvailability operation response. - * - * @member {boolean} [nameAvailable] A boolean value that indicates whether the - * name is available for you to use. If true, the name is available. If false, - * the name has already been taken or is invalid and cannot be used. - * @member {string} [reason] The reason that a vault name could not be used. - * The Reason element is only returned if NameAvailable is false. Possible - * values include: 'AccountNameInvalid', 'AlreadyExists' - * @member {string} [message] An error message explaining the Reason value in - * more detail. */ export interface CheckNameAvailabilityResult { + /** + * A boolean value that indicates whether the name is available for you to use. If true, the name + * is available. If false, the name has already been taken or is invalid and cannot be used. + */ readonly nameAvailable?: boolean; + /** + * The reason that a vault name could not be used. The Reason element is only returned if + * NameAvailable is false. Possible values include: 'AccountNameInvalid', 'AlreadyExists' + */ readonly reason?: string; + /** + * An error message explaining the Reason value in more detail. + */ readonly message?: string; } /** - * @class - * Initializes a new instance of the OperationDisplay class. - * @constructor * Display metadata associated with the operation. - * - * @member {string} [provider] Service provider: Microsoft Key Vault. - * @member {string} [resource] Resource on which the operation is performed - * etc. - * @member {string} [operation] Type of operation: get, read, delete, etc. - * @member {string} [description] Decription of operation. */ export interface OperationDisplay { + /** + * Service provider: Microsoft Key Vault. + */ provider?: string; + /** + * Resource on which the operation is performed etc. + */ resource?: string; + /** + * Type of operation: get, read, delete, etc. + */ operation?: string; + /** + * Description of operation. + */ description?: string; } /** - * @class - * Initializes a new instance of the LogSpecification class. - * @constructor * Log specification of operation. - * - * @member {string} [name] Name of log specification. - * @member {string} [displayName] Display name of log specification. - * @member {string} [blobDuration] Blob duration of specification. */ export interface LogSpecification { + /** + * Name of log specification. + */ name?: string; + /** + * Display name of log specification. + */ displayName?: string; + /** + * Blob duration of specification. + */ blobDuration?: string; } /** - * @class - * Initializes a new instance of the ServiceSpecification class. - * @constructor * One property of operation, include log specifications. - * - * @member {array} [logSpecifications] Log specifications of operation. */ export interface ServiceSpecification { + /** + * Log specifications of operation. + */ logSpecifications?: LogSpecification[]; } /** - * @class - * Initializes a new instance of the Operation class. - * @constructor * Key Vault REST API operation definition. - * - * @member {string} [name] Operation name: {provider}/{resource}/{operation} - * @member {object} [display] Display metadata associated with the operation. - * @member {string} [display.provider] Service provider: Microsoft Key Vault. - * @member {string} [display.resource] Resource on which the operation is - * performed etc. - * @member {string} [display.operation] Type of operation: get, read, delete, - * etc. - * @member {string} [display.description] Decription of operation. - * @member {string} [origin] The origin of operations. - * @member {object} [serviceSpecification] One property of operation, include - * metric specifications. - * @member {array} [serviceSpecification.logSpecifications] Log specifications - * of operation. */ export interface Operation { + /** + * Operation name: {provider}/{resource}/{operation} + */ name?: string; + /** + * Display metadata associated with the operation. + */ display?: OperationDisplay; + /** + * The origin of operations. + */ origin?: string; + /** + * One property of operation, include metric specifications. + */ serviceSpecification?: ServiceSpecification; } - /** - * @class - * Initializes a new instance of the VaultListResult class. - * @constructor * List of vaults - * - * @member {string} [nextLink] The URL to get the next set of vaults. */ export interface VaultListResult extends Array { + /** + * The URL to get the next set of vaults. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the DeletedVaultListResult class. - * @constructor * List of vaults - * - * @member {string} [nextLink] The URL to get the next set of deleted vaults. */ export interface DeletedVaultListResult extends Array { + /** + * The URL to get the next set of deleted vaults. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ResourceListResult class. - * @constructor * List of vault resources. - * - * @member {string} [nextLink] The URL to get the next set of vault resources. */ export interface ResourceListResult extends Array { + /** + * The URL to get the next set of vault resources. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the OperationListResult class. - * @constructor - * Result of the request to list Storage operations. It contains a list of - * operations and a URL link to get the next set of results. - * - * @member {string} [nextLink] The URL to get the next set of operations. + * Result of the request to list Storage operations. It contains a list of operations and a URL + * link to get the next set of results. */ export interface OperationListResult extends Array { + /** + * The URL to get the next set of operations. + */ nextLink?: string; } diff --git a/lib/services/keyVaultManagement/lib/models/logSpecification.js b/lib/services/keyVaultManagement/lib/models/logSpecification.js index fbf78a7c07..59cfb85858 100644 --- a/lib/services/keyVaultManagement/lib/models/logSpecification.js +++ b/lib/services/keyVaultManagement/lib/models/logSpecification.js @@ -17,9 +17,9 @@ class LogSpecification { /** * Create a LogSpecification. - * @member {string} [name] Name of log specification. - * @member {string} [displayName] Display name of log specification. - * @member {string} [blobDuration] Blob duration of specification. + * @property {string} [name] Name of log specification. + * @property {string} [displayName] Display name of log specification. + * @property {string} [blobDuration] Blob duration of specification. */ constructor() { } diff --git a/lib/services/keyVaultManagement/lib/models/networkRuleSet.js b/lib/services/keyVaultManagement/lib/models/networkRuleSet.js index 5f022c9a4e..382f522447 100644 --- a/lib/services/keyVaultManagement/lib/models/networkRuleSet.js +++ b/lib/services/keyVaultManagement/lib/models/networkRuleSet.js @@ -17,15 +17,15 @@ class NetworkRuleSet { /** * Create a NetworkRuleSet. - * @member {string} [bypass] Tells what traffic can bypass network rules. + * @property {string} [bypass] Tells what traffic can bypass network rules. * This can be 'AzureServices' or 'None'. If not specified the default is * 'AzureServices'. Possible values include: 'AzureServices', 'None' - * @member {string} [defaultAction] The default action when no rule from + * @property {string} [defaultAction] The default action when no rule from * ipRules and from virtualNetworkRules match. This is only used after the * bypass property has been evaluated. Possible values include: 'Allow', * 'Deny' - * @member {array} [ipRules] The list of IP address rules. - * @member {array} [virtualNetworkRules] The list of virtual network rules. + * @property {array} [ipRules] The list of IP address rules. + * @property {array} [virtualNetworkRules] The list of virtual network rules. */ constructor() { } diff --git a/lib/services/keyVaultManagement/lib/models/operation.js b/lib/services/keyVaultManagement/lib/models/operation.js index f46b32f282..7be1861468 100644 --- a/lib/services/keyVaultManagement/lib/models/operation.js +++ b/lib/services/keyVaultManagement/lib/models/operation.js @@ -17,18 +17,21 @@ class Operation { /** * Create a Operation. - * @member {string} [name] Operation name: {provider}/{resource}/{operation} - * @member {object} [display] Display metadata associated with the operation. - * @member {string} [display.provider] Service provider: Microsoft Key Vault. - * @member {string} [display.resource] Resource on which the operation is + * @property {string} [name] Operation name: + * {provider}/{resource}/{operation} + * @property {object} [display] Display metadata associated with the + * operation. + * @property {string} [display.provider] Service provider: Microsoft Key + * Vault. + * @property {string} [display.resource] Resource on which the operation is * performed etc. - * @member {string} [display.operation] Type of operation: get, read, delete, - * etc. - * @member {string} [display.description] Decription of operation. - * @member {string} [origin] The origin of operations. - * @member {object} [serviceSpecification] One property of operation, include - * metric specifications. - * @member {array} [serviceSpecification.logSpecifications] Log + * @property {string} [display.operation] Type of operation: get, read, + * delete, etc. + * @property {string} [display.description] Description of operation. + * @property {string} [origin] The origin of operations. + * @property {object} [serviceSpecification] One property of operation, + * include metric specifications. + * @property {array} [serviceSpecification.logSpecifications] Log * specifications of operation. */ constructor() { diff --git a/lib/services/keyVaultManagement/lib/models/operationDisplay.js b/lib/services/keyVaultManagement/lib/models/operationDisplay.js index 8cab4a170d..9c1f52b046 100644 --- a/lib/services/keyVaultManagement/lib/models/operationDisplay.js +++ b/lib/services/keyVaultManagement/lib/models/operationDisplay.js @@ -17,11 +17,11 @@ class OperationDisplay { /** * Create a OperationDisplay. - * @member {string} [provider] Service provider: Microsoft Key Vault. - * @member {string} [resource] Resource on which the operation is performed + * @property {string} [provider] Service provider: Microsoft Key Vault. + * @property {string} [resource] Resource on which the operation is performed * etc. - * @member {string} [operation] Type of operation: get, read, delete, etc. - * @member {string} [description] Decription of operation. + * @property {string} [operation] Type of operation: get, read, delete, etc. + * @property {string} [description] Description of operation. */ constructor() { } diff --git a/lib/services/keyVaultManagement/lib/models/operationListResult.js b/lib/services/keyVaultManagement/lib/models/operationListResult.js index f6662b8f6a..6dc9c7fec4 100644 --- a/lib/services/keyVaultManagement/lib/models/operationListResult.js +++ b/lib/services/keyVaultManagement/lib/models/operationListResult.js @@ -17,7 +17,7 @@ class OperationListResult extends Array { /** * Create a OperationListResult. - * @member {string} [nextLink] The URL to get the next set of operations. + * @property {string} [nextLink] The URL to get the next set of operations. */ constructor() { super(); diff --git a/lib/services/keyVaultManagement/lib/models/permissions.js b/lib/services/keyVaultManagement/lib/models/permissions.js index 63ad2f07e4..6b78ea9174 100755 --- a/lib/services/keyVaultManagement/lib/models/permissions.js +++ b/lib/services/keyVaultManagement/lib/models/permissions.js @@ -17,10 +17,10 @@ class Permissions { /** * Create a Permissions. - * @member {array} [keys] Permissions to keys - * @member {array} [secrets] Permissions to secrets - * @member {array} [certificates] Permissions to certificates - * @member {array} [storage] Permissions to storage accounts + * @property {array} [keys] Permissions to keys + * @property {array} [secrets] Permissions to secrets + * @property {array} [certificates] Permissions to certificates + * @property {array} [storage] Permissions to storage accounts */ constructor() { } diff --git a/lib/services/keyVaultManagement/lib/models/resource.js b/lib/services/keyVaultManagement/lib/models/resource.js index e23aafe21b..3a5adc4751 100755 --- a/lib/services/keyVaultManagement/lib/models/resource.js +++ b/lib/services/keyVaultManagement/lib/models/resource.js @@ -20,13 +20,13 @@ const models = require('./index'); class Resource extends models['BaseResource'] { /** * Create a Resource. - * @member {string} [id] The Azure Resource Manager resource ID for the key + * @property {string} [id] The Azure Resource Manager resource ID for the key * vault. - * @member {string} [name] The name of the key vault. - * @member {string} [type] The resource type of the key vault. - * @member {string} location The supported Azure location where the key vault - * should be created. - * @member {object} [tags] The tags that will be assigned to the key vault. + * @property {string} [name] The name of the key vault. + * @property {string} [type] The resource type of the key vault. + * @property {string} location The supported Azure location where the key + * vault should be created. + * @property {object} [tags] The tags that will be assigned to the key vault. */ constructor() { super(); diff --git a/lib/services/keyVaultManagement/lib/models/resourceListResult.js b/lib/services/keyVaultManagement/lib/models/resourceListResult.js index 9d094338fb..ef6ed5b49f 100755 --- a/lib/services/keyVaultManagement/lib/models/resourceListResult.js +++ b/lib/services/keyVaultManagement/lib/models/resourceListResult.js @@ -16,7 +16,7 @@ class ResourceListResult extends Array { /** * Create a ResourceListResult. - * @member {string} [nextLink] The URL to get the next set of vault + * @property {string} [nextLink] The URL to get the next set of vault * resources. */ constructor() { diff --git a/lib/services/keyVaultManagement/lib/models/serviceSpecification.js b/lib/services/keyVaultManagement/lib/models/serviceSpecification.js index 1f8d6aa264..b2771e5688 100644 --- a/lib/services/keyVaultManagement/lib/models/serviceSpecification.js +++ b/lib/services/keyVaultManagement/lib/models/serviceSpecification.js @@ -17,7 +17,7 @@ class ServiceSpecification { /** * Create a ServiceSpecification. - * @member {array} [logSpecifications] Log specifications of operation. + * @property {array} [logSpecifications] Log specifications of operation. */ constructor() { } diff --git a/lib/services/keyVaultManagement/lib/models/sku.js b/lib/services/keyVaultManagement/lib/models/sku.js index d9c3bffb35..c60f709409 100755 --- a/lib/services/keyVaultManagement/lib/models/sku.js +++ b/lib/services/keyVaultManagement/lib/models/sku.js @@ -17,7 +17,7 @@ class Sku { /** * Create a Sku. - * @member {string} name SKU name to specify whether the key vault is a + * @property {string} name SKU name to specify whether the key vault is a * standard vault or a premium vault. Possible values include: 'standard', * 'premium' */ diff --git a/lib/services/keyVaultManagement/lib/models/vault.js b/lib/services/keyVaultManagement/lib/models/vault.js index fab6833dc9..723a69219b 100755 --- a/lib/services/keyVaultManagement/lib/models/vault.js +++ b/lib/services/keyVaultManagement/lib/models/vault.js @@ -20,53 +20,53 @@ const models = require('./index'); class Vault extends models['Resource'] { /** * Create a Vault. - * @member {object} properties Properties of the vault - * @member {uuid} [properties.tenantId] The Azure Active Directory tenant ID - * that should be used for authenticating requests to the key vault. - * @member {object} [properties.sku] SKU details - * @member {string} [properties.sku.name] SKU name to specify whether the key - * vault is a standard vault or a premium vault. Possible values include: + * @property {object} properties Properties of the vault + * @property {uuid} [properties.tenantId] The Azure Active Directory tenant + * ID that should be used for authenticating requests to the key vault. + * @property {object} [properties.sku] SKU details + * @property {string} [properties.sku.name] SKU name to specify whether the + * key vault is a standard vault or a premium vault. Possible values include: * 'standard', 'premium' - * @member {array} [properties.accessPolicies] An array of 0 to 16 identities - * 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. - * @member {string} [properties.vaultUri] The URI of the vault for performing - * operations on keys and secrets. - * @member {boolean} [properties.enabledForDeployment] Property to specify + * @property {array} [properties.accessPolicies] An array of 0 to 16 + * identities 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. + * @property {string} [properties.vaultUri] The URI of the vault for + * performing operations on keys and secrets. + * @property {boolean} [properties.enabledForDeployment] Property to specify * whether Azure Virtual Machines are permitted to retrieve certificates * stored as secrets from the key vault. - * @member {boolean} [properties.enabledForDiskEncryption] Property to + * @property {boolean} [properties.enabledForDiskEncryption] Property to * specify whether Azure Disk Encryption is permitted to retrieve secrets * from the vault and unwrap keys. - * @member {boolean} [properties.enabledForTemplateDeployment] Property to + * @property {boolean} [properties.enabledForTemplateDeployment] Property to * specify whether Azure Resource Manager is permitted to retrieve secrets * from the key vault. - * @member {boolean} [properties.enableSoftDelete] Property to specify + * @property {boolean} [properties.enableSoftDelete] Property to specify * whether the 'soft delete' functionality is enabled for this key vault. It * does not accept false value. - * @member {string} [properties.createMode] The vault's create mode to + * @property {string} [properties.createMode] The vault's create mode to * indicate whether the vault need to be recovered or not. Possible values * include: 'recover', 'default' - * @member {boolean} [properties.enablePurgeProtection] Property specifying + * @property {boolean} [properties.enablePurgeProtection] Property specifying * whether protection against purge 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. - * @member {object} [properties.networkAcls] A collection of rules governing - * the accessibility of the vault from specific network locations. - * @member {string} [properties.networkAcls.bypass] Tells what traffic can + * @property {object} [properties.networkAcls] A collection of rules + * governing the accessibility of the vault from specific network locations. + * @property {string} [properties.networkAcls.bypass] Tells what traffic can * bypass network rules. This can be 'AzureServices' or 'None'. If not * specified the default is 'AzureServices'. Possible values include: * 'AzureServices', 'None' - * @member {string} [properties.networkAcls.defaultAction] The default action - * when no rule from ipRules and from virtualNetworkRules match. This is only - * used after the bypass property has been evaluated. Possible values + * @property {string} [properties.networkAcls.defaultAction] The default + * action when no rule from ipRules and from virtualNetworkRules match. This + * is only used after the bypass property has been evaluated. Possible values * include: 'Allow', 'Deny' - * @member {array} [properties.networkAcls.ipRules] The list of IP address + * @property {array} [properties.networkAcls.ipRules] The list of IP address * rules. - * @member {array} [properties.networkAcls.virtualNetworkRules] The list of + * @property {array} [properties.networkAcls.virtualNetworkRules] The list of * virtual network rules. */ constructor() { diff --git a/lib/services/keyVaultManagement/lib/models/vaultAccessPolicyParameters.js b/lib/services/keyVaultManagement/lib/models/vaultAccessPolicyParameters.js index ab1f52c76e..98aa74153a 100644 --- a/lib/services/keyVaultManagement/lib/models/vaultAccessPolicyParameters.js +++ b/lib/services/keyVaultManagement/lib/models/vaultAccessPolicyParameters.js @@ -20,14 +20,14 @@ const models = require('./index'); class VaultAccessPolicyParameters extends models['BaseResource'] { /** * Create a VaultAccessPolicyParameters. - * @member {string} [id] The resource id of the access policy. - * @member {string} [name] The resource name of the access policy. - * @member {string} [type] The resource name of the access policy. - * @member {string} [location] The resource type of the the access policy. - * @member {object} properties Properties of the access policy - * @member {array} [properties.accessPolicies] An array of 0 to 16 identities - * 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. + * @property {string} [id] The resource id of the access policy. + * @property {string} [name] The resource name of the access policy. + * @property {string} [type] The resource name of the access policy. + * @property {string} [location] The resource type of the access policy. + * @property {object} properties Properties of the access policy + * @property {array} [properties.accessPolicies] An array of 0 to 16 + * identities 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. */ constructor() { super(); diff --git a/lib/services/keyVaultManagement/lib/models/vaultAccessPolicyProperties.js b/lib/services/keyVaultManagement/lib/models/vaultAccessPolicyProperties.js index ab6f40667f..c8453ecf1f 100644 --- a/lib/services/keyVaultManagement/lib/models/vaultAccessPolicyProperties.js +++ b/lib/services/keyVaultManagement/lib/models/vaultAccessPolicyProperties.js @@ -17,7 +17,7 @@ class VaultAccessPolicyProperties { /** * Create a VaultAccessPolicyProperties. - * @member {array} accessPolicies An array of 0 to 16 identities that have + * @property {array} accessPolicies An array of 0 to 16 identities 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. */ diff --git a/lib/services/keyVaultManagement/lib/models/vaultCheckNameAvailabilityParameters.js b/lib/services/keyVaultManagement/lib/models/vaultCheckNameAvailabilityParameters.js index e8aaa893d7..d478057142 100644 --- a/lib/services/keyVaultManagement/lib/models/vaultCheckNameAvailabilityParameters.js +++ b/lib/services/keyVaultManagement/lib/models/vaultCheckNameAvailabilityParameters.js @@ -11,13 +11,13 @@ 'use strict'; /** - * The parameters used to check the availabity of the vault name. + * The parameters used to check the availability of the vault name. * */ class VaultCheckNameAvailabilityParameters { /** * Create a VaultCheckNameAvailabilityParameters. - * @member {string} name The vault name. + * @property {string} name The vault name. */ constructor() { } diff --git a/lib/services/keyVaultManagement/lib/models/vaultCreateOrUpdateParameters.js b/lib/services/keyVaultManagement/lib/models/vaultCreateOrUpdateParameters.js index bf7b71e85b..d2c87514da 100755 --- a/lib/services/keyVaultManagement/lib/models/vaultCreateOrUpdateParameters.js +++ b/lib/services/keyVaultManagement/lib/models/vaultCreateOrUpdateParameters.js @@ -20,56 +20,56 @@ const models = require('./index'); class VaultCreateOrUpdateParameters extends models['BaseResource'] { /** * Create a VaultCreateOrUpdateParameters. - * @member {string} location The supported Azure location where the key vault - * should be created. - * @member {object} [tags] The tags that will be assigned to the key vault. - * @member {object} properties Properties of the vault - * @member {uuid} [properties.tenantId] The Azure Active Directory tenant ID - * that should be used for authenticating requests to the key vault. - * @member {object} [properties.sku] SKU details - * @member {string} [properties.sku.name] SKU name to specify whether the key - * vault is a standard vault or a premium vault. Possible values include: + * @property {string} location The supported Azure location where the key + * vault should be created. + * @property {object} [tags] The tags that will be assigned to the key vault. + * @property {object} properties Properties of the vault + * @property {uuid} [properties.tenantId] The Azure Active Directory tenant + * ID that should be used for authenticating requests to the key vault. + * @property {object} [properties.sku] SKU details + * @property {string} [properties.sku.name] SKU name to specify whether the + * key vault is a standard vault or a premium vault. Possible values include: * 'standard', 'premium' - * @member {array} [properties.accessPolicies] An array of 0 to 16 identities - * 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. - * @member {string} [properties.vaultUri] The URI of the vault for performing - * operations on keys and secrets. - * @member {boolean} [properties.enabledForDeployment] Property to specify + * @property {array} [properties.accessPolicies] An array of 0 to 16 + * identities 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. + * @property {string} [properties.vaultUri] The URI of the vault for + * performing operations on keys and secrets. + * @property {boolean} [properties.enabledForDeployment] Property to specify * whether Azure Virtual Machines are permitted to retrieve certificates * stored as secrets from the key vault. - * @member {boolean} [properties.enabledForDiskEncryption] Property to + * @property {boolean} [properties.enabledForDiskEncryption] Property to * specify whether Azure Disk Encryption is permitted to retrieve secrets * from the vault and unwrap keys. - * @member {boolean} [properties.enabledForTemplateDeployment] Property to + * @property {boolean} [properties.enabledForTemplateDeployment] Property to * specify whether Azure Resource Manager is permitted to retrieve secrets * from the key vault. - * @member {boolean} [properties.enableSoftDelete] Property to specify + * @property {boolean} [properties.enableSoftDelete] Property to specify * whether the 'soft delete' functionality is enabled for this key vault. It * does not accept false value. - * @member {string} [properties.createMode] The vault's create mode to + * @property {string} [properties.createMode] The vault's create mode to * indicate whether the vault need to be recovered or not. Possible values * include: 'recover', 'default' - * @member {boolean} [properties.enablePurgeProtection] Property specifying + * @property {boolean} [properties.enablePurgeProtection] Property specifying * whether protection against purge 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. - * @member {object} [properties.networkAcls] A collection of rules governing - * the accessibility of the vault from specific network locations. - * @member {string} [properties.networkAcls.bypass] Tells what traffic can + * @property {object} [properties.networkAcls] A collection of rules + * governing the accessibility of the vault from specific network locations. + * @property {string} [properties.networkAcls.bypass] Tells what traffic can * bypass network rules. This can be 'AzureServices' or 'None'. If not * specified the default is 'AzureServices'. Possible values include: * 'AzureServices', 'None' - * @member {string} [properties.networkAcls.defaultAction] The default action - * when no rule from ipRules and from virtualNetworkRules match. This is only - * used after the bypass property has been evaluated. Possible values + * @property {string} [properties.networkAcls.defaultAction] The default + * action when no rule from ipRules and from virtualNetworkRules match. This + * is only used after the bypass property has been evaluated. Possible values * include: 'Allow', 'Deny' - * @member {array} [properties.networkAcls.ipRules] The list of IP address + * @property {array} [properties.networkAcls.ipRules] The list of IP address * rules. - * @member {array} [properties.networkAcls.virtualNetworkRules] The list of + * @property {array} [properties.networkAcls.virtualNetworkRules] The list of * virtual network rules. */ constructor() { diff --git a/lib/services/keyVaultManagement/lib/models/vaultListResult.js b/lib/services/keyVaultManagement/lib/models/vaultListResult.js index 00ded6fd06..80be5e41c7 100755 --- a/lib/services/keyVaultManagement/lib/models/vaultListResult.js +++ b/lib/services/keyVaultManagement/lib/models/vaultListResult.js @@ -16,7 +16,7 @@ class VaultListResult extends Array { /** * Create a VaultListResult. - * @member {string} [nextLink] The URL to get the next set of vaults. + * @property {string} [nextLink] The URL to get the next set of vaults. */ constructor() { super(); diff --git a/lib/services/keyVaultManagement/lib/models/vaultPatchParameters.js b/lib/services/keyVaultManagement/lib/models/vaultPatchParameters.js index 15d8a39f5f..91d15d0d44 100644 --- a/lib/services/keyVaultManagement/lib/models/vaultPatchParameters.js +++ b/lib/services/keyVaultManagement/lib/models/vaultPatchParameters.js @@ -20,52 +20,52 @@ const models = require('./index'); class VaultPatchParameters extends models['BaseResource'] { /** * Create a VaultPatchParameters. - * @member {object} [tags] The tags that will be assigned to the key vault. - * @member {object} [properties] Properties of the vault - * @member {uuid} [properties.tenantId] The Azure Active Directory tenant ID - * that should be used for authenticating requests to the key vault. - * @member {object} [properties.sku] SKU details - * @member {string} [properties.sku.name] SKU name to specify whether the key - * vault is a standard vault or a premium vault. Possible values include: + * @property {object} [tags] The tags that will be assigned to the key vault. + * @property {object} [properties] Properties of the vault + * @property {uuid} [properties.tenantId] The Azure Active Directory tenant + * ID that should be used for authenticating requests to the key vault. + * @property {object} [properties.sku] SKU details + * @property {string} [properties.sku.name] SKU name to specify whether the + * key vault is a standard vault or a premium vault. Possible values include: * 'standard', 'premium' - * @member {array} [properties.accessPolicies] An array of 0 to 16 identities - * 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. - * @member {boolean} [properties.enabledForDeployment] Property to specify + * @property {array} [properties.accessPolicies] An array of 0 to 16 + * identities 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. + * @property {boolean} [properties.enabledForDeployment] Property to specify * whether Azure Virtual Machines are permitted to retrieve certificates * stored as secrets from the key vault. - * @member {boolean} [properties.enabledForDiskEncryption] Property to + * @property {boolean} [properties.enabledForDiskEncryption] Property to * specify whether Azure Disk Encryption is permitted to retrieve secrets * from the vault and unwrap keys. - * @member {boolean} [properties.enabledForTemplateDeployment] Property to + * @property {boolean} [properties.enabledForTemplateDeployment] Property to * specify whether Azure Resource Manager is permitted to retrieve secrets * from the key vault. - * @member {boolean} [properties.enableSoftDelete] Property to specify + * @property {boolean} [properties.enableSoftDelete] Property to specify * whether the 'soft delete' functionality is enabled for this key vault. It * does not accept false value. - * @member {string} [properties.createMode] The vault's create mode to + * @property {string} [properties.createMode] The vault's create mode to * indicate whether the vault need to be recovered or not. Possible values * include: 'recover', 'default' - * @member {boolean} [properties.enablePurgeProtection] Property specifying + * @property {boolean} [properties.enablePurgeProtection] Property specifying * whether protection against purge 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. - * @member {object} [properties.networkAcls] A collection of rules governing - * the accessibility of the vault from specific network locations. - * @member {string} [properties.networkAcls.bypass] Tells what traffic can + * @property {object} [properties.networkAcls] A collection of rules + * governing the accessibility of the vault from specific network locations. + * @property {string} [properties.networkAcls.bypass] Tells what traffic can * bypass network rules. This can be 'AzureServices' or 'None'. If not * specified the default is 'AzureServices'. Possible values include: * 'AzureServices', 'None' - * @member {string} [properties.networkAcls.defaultAction] The default action - * when no rule from ipRules and from virtualNetworkRules match. This is only - * used after the bypass property has been evaluated. Possible values + * @property {string} [properties.networkAcls.defaultAction] The default + * action when no rule from ipRules and from virtualNetworkRules match. This + * is only used after the bypass property has been evaluated. Possible values * include: 'Allow', 'Deny' - * @member {array} [properties.networkAcls.ipRules] The list of IP address + * @property {array} [properties.networkAcls.ipRules] The list of IP address * rules. - * @member {array} [properties.networkAcls.virtualNetworkRules] The list of + * @property {array} [properties.networkAcls.virtualNetworkRules] The list of * virtual network rules. */ constructor() { diff --git a/lib/services/keyVaultManagement/lib/models/vaultPatchProperties.js b/lib/services/keyVaultManagement/lib/models/vaultPatchProperties.js index d61ee7ea1c..9961c81ad9 100644 --- a/lib/services/keyVaultManagement/lib/models/vaultPatchProperties.js +++ b/lib/services/keyVaultManagement/lib/models/vaultPatchProperties.js @@ -17,49 +17,49 @@ class VaultPatchProperties { /** * Create a VaultPatchProperties. - * @member {uuid} [tenantId] The Azure Active Directory tenant ID that should - * be used for authenticating requests to the key vault. - * @member {object} [sku] SKU details - * @member {string} [sku.name] SKU name to specify whether the key vault is a - * standard vault or a premium vault. Possible values include: 'standard', + * @property {uuid} [tenantId] The Azure Active Directory tenant ID that + * should be used for authenticating requests to the key vault. + * @property {object} [sku] SKU details + * @property {string} [sku.name] SKU name to specify whether the key vault is + * a standard vault or a premium vault. Possible values include: 'standard', * 'premium' - * @member {array} [accessPolicies] An array of 0 to 16 identities 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. - * @member {boolean} [enabledForDeployment] Property to specify whether Azure - * Virtual Machines are permitted to retrieve certificates stored as secrets - * from the key vault. - * @member {boolean} [enabledForDiskEncryption] Property to specify whether + * @property {array} [accessPolicies] An array of 0 to 16 identities 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. + * @property {boolean} [enabledForDeployment] Property to specify whether + * Azure Virtual Machines are permitted to retrieve certificates stored as + * secrets from the key vault. + * @property {boolean} [enabledForDiskEncryption] Property to specify whether * Azure Disk Encryption is permitted to retrieve secrets from the vault and * unwrap keys. - * @member {boolean} [enabledForTemplateDeployment] Property to specify + * @property {boolean} [enabledForTemplateDeployment] Property to specify * whether Azure Resource Manager is permitted to retrieve secrets from the * key vault. - * @member {boolean} [enableSoftDelete] Property to specify whether the 'soft - * delete' functionality is enabled for this key vault. It does not accept - * false value. - * @member {string} [createMode] The vault's create mode to indicate whether - * the vault need to be recovered or not. Possible values include: 'recover', - * 'default' - * @member {boolean} [enablePurgeProtection] Property specifying whether + * @property {boolean} [enableSoftDelete] Property to specify whether the + * 'soft delete' functionality is enabled for this key vault. It does not + * accept false value. + * @property {string} [createMode] The vault's create mode to indicate + * whether the vault need to be recovered or not. Possible values include: + * 'recover', 'default' + * @property {boolean} [enablePurgeProtection] Property specifying whether * protection against purge 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. - * @member {object} [networkAcls] A collection of rules governing the + * @property {object} [networkAcls] A collection of rules governing the * accessibility of the vault from specific network locations. - * @member {string} [networkAcls.bypass] Tells what traffic can bypass + * @property {string} [networkAcls.bypass] Tells what traffic can bypass * network rules. This can be 'AzureServices' or 'None'. If not specified * the default is 'AzureServices'. Possible values include: 'AzureServices', * 'None' - * @member {string} [networkAcls.defaultAction] The default action when no + * @property {string} [networkAcls.defaultAction] The default action when no * rule from ipRules and from virtualNetworkRules match. This is only used * after the bypass property has been evaluated. Possible values include: * 'Allow', 'Deny' - * @member {array} [networkAcls.ipRules] The list of IP address rules. - * @member {array} [networkAcls.virtualNetworkRules] The list of virtual + * @property {array} [networkAcls.ipRules] The list of IP address rules. + * @property {array} [networkAcls.virtualNetworkRules] The list of virtual * network rules. */ constructor() { diff --git a/lib/services/keyVaultManagement/lib/models/vaultProperties.js b/lib/services/keyVaultManagement/lib/models/vaultProperties.js index b7082ac7a2..e45d7e6c29 100755 --- a/lib/services/keyVaultManagement/lib/models/vaultProperties.js +++ b/lib/services/keyVaultManagement/lib/models/vaultProperties.js @@ -17,51 +17,51 @@ class VaultProperties { /** * Create a VaultProperties. - * @member {uuid} tenantId The Azure Active Directory tenant ID that should + * @property {uuid} tenantId The Azure Active Directory tenant ID that should * be used for authenticating requests to the key vault. - * @member {object} sku SKU details - * @member {string} [sku.name] SKU name to specify whether the key vault is a - * standard vault or a premium vault. Possible values include: 'standard', + * @property {object} sku SKU details + * @property {string} [sku.name] SKU name to specify whether the key vault is + * a standard vault or a premium vault. Possible values include: 'standard', * 'premium' - * @member {array} [accessPolicies] An array of 0 to 16 identities 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. - * @member {string} [vaultUri] The URI of the vault for performing operations - * on keys and secrets. - * @member {boolean} [enabledForDeployment] Property to specify whether Azure - * Virtual Machines are permitted to retrieve certificates stored as secrets - * from the key vault. - * @member {boolean} [enabledForDiskEncryption] Property to specify whether + * @property {array} [accessPolicies] An array of 0 to 16 identities 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. + * @property {string} [vaultUri] The URI of the vault for performing + * operations on keys and secrets. + * @property {boolean} [enabledForDeployment] Property to specify whether + * Azure Virtual Machines are permitted to retrieve certificates stored as + * secrets from the key vault. + * @property {boolean} [enabledForDiskEncryption] Property to specify whether * Azure Disk Encryption is permitted to retrieve secrets from the vault and * unwrap keys. - * @member {boolean} [enabledForTemplateDeployment] Property to specify + * @property {boolean} [enabledForTemplateDeployment] Property to specify * whether Azure Resource Manager is permitted to retrieve secrets from the * key vault. - * @member {boolean} [enableSoftDelete] Property to specify whether the 'soft - * delete' functionality is enabled for this key vault. It does not accept - * false value. - * @member {string} [createMode] The vault's create mode to indicate whether - * the vault need to be recovered or not. Possible values include: 'recover', - * 'default' - * @member {boolean} [enablePurgeProtection] Property specifying whether + * @property {boolean} [enableSoftDelete] Property to specify whether the + * 'soft delete' functionality is enabled for this key vault. It does not + * accept false value. + * @property {string} [createMode] The vault's create mode to indicate + * whether the vault need to be recovered or not. Possible values include: + * 'recover', 'default' + * @property {boolean} [enablePurgeProtection] Property specifying whether * protection against purge 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. - * @member {object} [networkAcls] A collection of rules governing the + * @property {object} [networkAcls] A collection of rules governing the * accessibility of the vault from specific network locations. - * @member {string} [networkAcls.bypass] Tells what traffic can bypass + * @property {string} [networkAcls.bypass] Tells what traffic can bypass * network rules. This can be 'AzureServices' or 'None'. If not specified * the default is 'AzureServices'. Possible values include: 'AzureServices', * 'None' - * @member {string} [networkAcls.defaultAction] The default action when no + * @property {string} [networkAcls.defaultAction] The default action when no * rule from ipRules and from virtualNetworkRules match. This is only used * after the bypass property has been evaluated. Possible values include: * 'Allow', 'Deny' - * @member {array} [networkAcls.ipRules] The list of IP address rules. - * @member {array} [networkAcls.virtualNetworkRules] The list of virtual + * @property {array} [networkAcls.ipRules] The list of IP address rules. + * @property {array} [networkAcls.virtualNetworkRules] The list of virtual * network rules. */ constructor() { diff --git a/lib/services/keyVaultManagement/lib/models/virtualNetworkRule.js b/lib/services/keyVaultManagement/lib/models/virtualNetworkRule.js index 9a7f5967a3..c2921596e1 100644 --- a/lib/services/keyVaultManagement/lib/models/virtualNetworkRule.js +++ b/lib/services/keyVaultManagement/lib/models/virtualNetworkRule.js @@ -11,14 +11,14 @@ 'use strict'; /** - * A rule governing the accesibility of a vault from a specific virtual + * A rule governing the accessibility of a vault from a specific virtual * network. * */ class VirtualNetworkRule { /** * Create a VirtualNetworkRule. - * @member {string} id Full resource id of a vnet subnet, such as + * @property {string} id Full resource id of a vnet subnet, such as * '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. */ constructor() { diff --git a/lib/services/keyVaultManagement/package.json b/lib/services/keyVaultManagement/package.json index 14b1a52844..aa4996ffe6 100644 --- a/lib/services/keyVaultManagement/package.json +++ b/lib/services/keyVaultManagement/package.json @@ -22,4 +22,4 @@ "bugs": { "url": "https://github.com/azure/azure-sdk-for-node/issues" } -} \ No newline at end of file +} From b80f5dc92dc6ef8e102f1ecb313f6892722e4569 Mon Sep 17 00:00:00 2001 From: Azure SDK for Python bot Date: Thu, 7 Feb 2019 17:06:41 -0800 Subject: [PATCH 2/2] Generated from bddc29df0c1abc1a1f25b2b2a07c6deb2043c2e6 (#4653) add description of access policies required condition --- lib/services/keyVaultManagement/LICENSE.txt | 2 +- .../keyVaultManagement/lib/models/index.d.ts | 3 ++- .../keyVaultManagement/lib/models/vault.js | 4 +++- .../models/vaultCreateOrUpdateParameters.js | 4 +++- .../lib/models/vaultProperties.js | 4 +++- .../lib/operations/index.d.ts | 16 +++++++++---- .../lib/operations/vaults.js | 24 ++++++++++++++----- 7 files changed, 42 insertions(+), 15 deletions(-) diff --git a/lib/services/keyVaultManagement/LICENSE.txt b/lib/services/keyVaultManagement/LICENSE.txt index 5431ba98b9..8f3d856145 100644 --- a/lib/services/keyVaultManagement/LICENSE.txt +++ b/lib/services/keyVaultManagement/LICENSE.txt @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2018 Microsoft +Copyright (c) 2019 Microsoft Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/lib/services/keyVaultManagement/lib/models/index.d.ts b/lib/services/keyVaultManagement/lib/models/index.d.ts index 3c79b3e6bb..482c799aea 100755 --- a/lib/services/keyVaultManagement/lib/models/index.d.ts +++ b/lib/services/keyVaultManagement/lib/models/index.d.ts @@ -134,7 +134,8 @@ export interface VaultProperties { sku: Sku; /** * An array of 0 to 16 identities 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. + * 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. */ accessPolicies?: AccessPolicyEntry[]; /** diff --git a/lib/services/keyVaultManagement/lib/models/vault.js b/lib/services/keyVaultManagement/lib/models/vault.js index 723a69219b..3145600867 100755 --- a/lib/services/keyVaultManagement/lib/models/vault.js +++ b/lib/services/keyVaultManagement/lib/models/vault.js @@ -29,7 +29,9 @@ class Vault extends models['Resource'] { * 'standard', 'premium' * @property {array} [properties.accessPolicies] An array of 0 to 16 * identities 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. + * 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. * @property {string} [properties.vaultUri] The URI of the vault for * performing operations on keys and secrets. * @property {boolean} [properties.enabledForDeployment] Property to specify diff --git a/lib/services/keyVaultManagement/lib/models/vaultCreateOrUpdateParameters.js b/lib/services/keyVaultManagement/lib/models/vaultCreateOrUpdateParameters.js index d2c87514da..a9ba953158 100755 --- a/lib/services/keyVaultManagement/lib/models/vaultCreateOrUpdateParameters.js +++ b/lib/services/keyVaultManagement/lib/models/vaultCreateOrUpdateParameters.js @@ -32,7 +32,9 @@ class VaultCreateOrUpdateParameters extends models['BaseResource'] { * 'standard', 'premium' * @property {array} [properties.accessPolicies] An array of 0 to 16 * identities 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. + * 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. * @property {string} [properties.vaultUri] The URI of the vault for * performing operations on keys and secrets. * @property {boolean} [properties.enabledForDeployment] Property to specify diff --git a/lib/services/keyVaultManagement/lib/models/vaultProperties.js b/lib/services/keyVaultManagement/lib/models/vaultProperties.js index e45d7e6c29..8f92c9f24f 100755 --- a/lib/services/keyVaultManagement/lib/models/vaultProperties.js +++ b/lib/services/keyVaultManagement/lib/models/vaultProperties.js @@ -25,7 +25,9 @@ class VaultProperties { * 'premium' * @property {array} [accessPolicies] An array of 0 to 16 identities 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. + * 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. * @property {string} [vaultUri] The URI of the vault for performing * operations on keys and secrets. * @property {boolean} [enabledForDeployment] Property to specify whether diff --git a/lib/services/keyVaultManagement/lib/operations/index.d.ts b/lib/services/keyVaultManagement/lib/operations/index.d.ts index e74f821406..0fdb2ade85 100755 --- a/lib/services/keyVaultManagement/lib/operations/index.d.ts +++ b/lib/services/keyVaultManagement/lib/operations/index.d.ts @@ -50,7 +50,9 @@ export interface Vaults { * * @param {array} [parameters.properties.accessPolicies] An array of 0 to 16 * identities 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. + * 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. * * @param {string} [parameters.properties.vaultUri] The URI of the vault for * performing operations on keys and secrets. @@ -144,7 +146,9 @@ export interface Vaults { * * @param {array} [parameters.properties.accessPolicies] An array of 0 to 16 * identities 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. + * 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. * * @param {string} [parameters.properties.vaultUri] The URI of the vault for * performing operations on keys and secrets. @@ -1065,7 +1069,9 @@ export interface Vaults { * * @param {array} [parameters.properties.accessPolicies] An array of 0 to 16 * identities 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. + * 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. * * @param {string} [parameters.properties.vaultUri] The URI of the vault for * performing operations on keys and secrets. @@ -1159,7 +1165,9 @@ export interface Vaults { * * @param {array} [parameters.properties.accessPolicies] An array of 0 to 16 * identities 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. + * 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. * * @param {string} [parameters.properties.vaultUri] The URI of the vault for * performing operations on keys and secrets. diff --git a/lib/services/keyVaultManagement/lib/operations/vaults.js b/lib/services/keyVaultManagement/lib/operations/vaults.js index c45da5efe7..4a3a1eb20a 100755 --- a/lib/services/keyVaultManagement/lib/operations/vaults.js +++ b/lib/services/keyVaultManagement/lib/operations/vaults.js @@ -44,7 +44,9 @@ const WebResource = msRest.WebResource; * * @param {array} [parameters.properties.accessPolicies] An array of 0 to 16 * identities 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. + * 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. * * @param {string} [parameters.properties.vaultUri] The URI of the vault for * performing operations on keys and secrets. @@ -1871,7 +1873,9 @@ function _checkNameAvailability(vaultName, options, callback) { * * @param {array} [parameters.properties.accessPolicies] An array of 0 to 16 * identities 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. + * 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. * * @param {string} [parameters.properties.vaultUri] The URI of the vault for * performing operations on keys and secrets. @@ -2802,7 +2806,9 @@ class Vaults { * * @param {array} [parameters.properties.accessPolicies] An array of 0 to 16 * identities 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. + * 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. * * @param {string} [parameters.properties.vaultUri] The URI of the vault for * performing operations on keys and secrets. @@ -2908,7 +2914,9 @@ class Vaults { * * @param {array} [parameters.properties.accessPolicies] An array of 0 to 16 * identities 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. + * 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. * * @param {string} [parameters.properties.vaultUri] The URI of the vault for * performing operations on keys and secrets. @@ -4141,7 +4149,9 @@ class Vaults { * * @param {array} [parameters.properties.accessPolicies] An array of 0 to 16 * identities 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. + * 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. * * @param {string} [parameters.properties.vaultUri] The URI of the vault for * performing operations on keys and secrets. @@ -4247,7 +4257,9 @@ class Vaults { * * @param {array} [parameters.properties.accessPolicies] An array of 0 to 16 * identities 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. + * 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. * * @param {string} [parameters.properties.vaultUri] The URI of the vault for * performing operations on keys and secrets.