From 67d255be4c4b579e2204e02991683e787f13d055 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Fri, 10 Feb 2023 14:08:24 +0100 Subject: [PATCH] Regenerated all docs --- modules/Microsoft.AAD/DomainServices/readme.md | 4 ++-- .../service/authorizationServers/readme.md | 4 ++-- .../service/identityProviders/readme.md | 2 +- modules/Microsoft.Compute/virtualMachineScaleSets/readme.md | 6 +++--- modules/Microsoft.Compute/virtualMachines/readme.md | 6 +++--- modules/Microsoft.DBforPostgreSQL/flexibleServers/readme.md | 2 +- modules/Microsoft.DevTestLab/labs/artifactSources/readme.md | 2 +- modules/Microsoft.KeyVault/vaults/secrets/readme.md | 4 ++-- modules/Microsoft.NetApp/netAppAccounts/readme.md | 2 +- modules/Microsoft.Network/localNetworkGateways/readme.md | 2 +- modules/Microsoft.Sql/managedInstances/readme.md | 2 +- modules/Microsoft.Sql/servers/readme.md | 2 +- .../Microsoft.Sql/servers/securityAlertPolicies/readme.md | 2 +- modules/Microsoft.Web/staticSites/readme.md | 2 +- 14 files changed, 21 insertions(+), 21 deletions(-) diff --git a/modules/Microsoft.AAD/DomainServices/readme.md b/modules/Microsoft.AAD/DomainServices/readme.md index bddb5fb45b..2d78a24a52 100644 --- a/modules/Microsoft.AAD/DomainServices/readme.md +++ b/modules/Microsoft.AAD/DomainServices/readme.md @@ -32,8 +32,8 @@ This template deploys Azure Active Directory Domain Services (AADDS). | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | -| `pfxCertificate` | secureString | `''` | The certificate required to configure Secure LDAP. Should be a base64encoded representation of the certificate PFX file. Required if secure LDAP is enabled and must be valid more than 30 days. | -| `pfxCertificatePassword` | secureString | `''` | The password to decrypt the provided Secure LDAP certificate PFX file. Required if secure LDAP is enabled. | +| `pfxCertificate` | securestring | `''` | The certificate required to configure Secure LDAP. Should be a base64encoded representation of the certificate PFX file. Required if secure LDAP is enabled and must be valid more than 30 days. | +| `pfxCertificatePassword` | securestring | `''` | The password to decrypt the provided Secure LDAP certificate PFX file. Required if secure LDAP is enabled. | **Optional parameters** diff --git a/modules/Microsoft.ApiManagement/service/authorizationServers/readme.md b/modules/Microsoft.ApiManagement/service/authorizationServers/readme.md index e92fdae8eb..363caafe8f 100644 --- a/modules/Microsoft.ApiManagement/service/authorizationServers/readme.md +++ b/modules/Microsoft.ApiManagement/service/authorizationServers/readme.md @@ -28,8 +28,8 @@ The following resources are required to be able to deploy this resource. | Parameter Name | Type | Description | | :-- | :-- | :-- | | `authorizationEndpoint` | string | OAuth authorization endpoint. See . | -| `clientId` | secureString | Client or app ID registered with this authorization server. | -| `clientSecret` | secureString | Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. | +| `clientId` | securestring | Client or app ID registered with this authorization server. | +| `clientSecret` | securestring | Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. | | `grantTypes` | array | Form of an authorization grant, which the client uses to request the access token. - authorizationCode, implicit, resourceOwnerPassword, clientCredentials. | | `name` | string | Identifier of the authorization server. | diff --git a/modules/Microsoft.ApiManagement/service/identityProviders/readme.md b/modules/Microsoft.ApiManagement/service/identityProviders/readme.md index 78569a5aec..2c462b84be 100644 --- a/modules/Microsoft.ApiManagement/service/identityProviders/readme.md +++ b/modules/Microsoft.ApiManagement/service/identityProviders/readme.md @@ -29,7 +29,7 @@ This module deploys API Management Service Identity Provider. | :-- | :-- | :-- | :-- | | `apiManagementServiceName` | string | | The name of the parent API Management service. Required if the template is used in a standalone deployment. | | `identityProviderClientId` | string | `''` | Client ID of the Application in the external Identity Provider. Required if identity provider is used. | -| `identityProviderClientSecret` | secureString | `''` | Client secret of the Application in external Identity Provider, used to authenticate login request. Required if identity provider is used. | +| `identityProviderClientSecret` | securestring | `''` | Client secret of the Application in external Identity Provider, used to authenticate login request. Required if identity provider is used. | **Optional parameters** diff --git a/modules/Microsoft.Compute/virtualMachineScaleSets/readme.md b/modules/Microsoft.Compute/virtualMachineScaleSets/readme.md index 522e82f6a0..51e3959cb9 100644 --- a/modules/Microsoft.Compute/virtualMachineScaleSets/readme.md +++ b/modules/Microsoft.Compute/virtualMachineScaleSets/readme.md @@ -32,7 +32,7 @@ The following resources are required to be able to deploy this resource. | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | -| `adminUsername` | secureString | | Administrator username. | +| `adminUsername` | securestring | | Administrator username. | | `imageReference` | object | | OS image reference. In case of marketplace images, it's the combination of the publisher, offer, sku, version attributes. In case of custom images it's the resource ID of the custom image. | | `name` | string | | Name of the VMSS. | | `nicConfigurations` | array | | Configures NICs and PIPs. | @@ -45,7 +45,7 @@ The following resources are required to be able to deploy this resource. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `additionalUnattendContent` | array | `[]` | | Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - AdditionalUnattendContent object. | -| `adminPassword` | secureString | `''` | | When specifying a Windows Virtual Machine, this value should be passed. | +| `adminPassword` | securestring | `''` | | When specifying a Windows Virtual Machine, this value should be passed. | | `automaticRepairsPolicyEnabled` | bool | `False` | | Specifies whether automatic repairs should be enabled on the virtual machine scale set. | | `availabilityZones` | array | `[]` | | The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set. | | `bootDiagnosticStorageAccountName` | string | `''` | | Storage account used to store boot diagnostic information. Boot diagnostics will be disabled if no value is provided. | @@ -71,7 +71,7 @@ The following resources are required to be able to deploy this resource. | `extensionCustomScriptConfig` | object | `{object}` | | The configuration for the [Custom Script] extension. Must at least contain the ["enabled": true] property to be executed. | | `extensionDependencyAgentConfig` | object | `{object}` | | The configuration for the [Dependency Agent] extension. Must at least contain the ["enabled": true] property to be executed. | | `extensionDomainJoinConfig` | object | `{object}` | | The configuration for the [Domain Join] extension. Must at least contain the ["enabled": true] property to be executed. | -| `extensionDomainJoinPassword` | secureString | `''` | | Required if name is specified. Password of the user specified in user parameter. | +| `extensionDomainJoinPassword` | securestring | `''` | | Required if name is specified. Password of the user specified in user parameter. | | `extensionDSCConfig` | object | `{object}` | | The configuration for the [Desired State Configuration] extension. Must at least contain the ["enabled": true] property to be executed. | | `extensionMonitoringAgentConfig` | object | `{object}` | | The configuration for the [Monitoring Agent] extension. Must at least contain the ["enabled": true] property to be executed. | | `extensionNetworkWatcherAgentConfig` | object | `{object}` | | The configuration for the [Network Watcher Agent] extension. Must at least contain the ["enabled": true] property to be executed. | diff --git a/modules/Microsoft.Compute/virtualMachines/readme.md b/modules/Microsoft.Compute/virtualMachines/readme.md index 9faa389b81..5bcbf1b69f 100644 --- a/modules/Microsoft.Compute/virtualMachines/readme.md +++ b/modules/Microsoft.Compute/virtualMachines/readme.md @@ -31,7 +31,7 @@ This module deploys one Virtual Machine with one or multiple NICs and optionally | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `adminUsername` | secureString | | | Administrator username. | +| `adminUsername` | securestring | | | Administrator username. | | `configurationProfile` | string | `''` | `['', /providers/Microsoft.Automanage/bestPractices/AzureBestPracticesDevTest, /providers/Microsoft.Automanage/bestPractices/AzureBestPracticesProduction]` | The configuration profile of automanage. | | `imageReference` | object | | | OS image reference. In case of marketplace images, it's the combination of the publisher, offer, sku, version attributes. In case of custom images it's the resource ID of the custom image. | | `nicConfigurations` | array | | | Configures NICs and PIPs. | @@ -44,7 +44,7 @@ This module deploys one Virtual Machine with one or multiple NICs and optionally | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `additionalUnattendContent` | array | `[]` | | Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - AdditionalUnattendContent object. | -| `adminPassword` | secureString | `''` | | When specifying a Windows Virtual Machine, this value should be passed. | +| `adminPassword` | securestring | `''` | | When specifying a Windows Virtual Machine, this value should be passed. | | `allowExtensionOperations` | bool | `True` | | Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine. | | `availabilitySetResourceId` | string | `''` | | Resource ID of an availability set. Cannot be used in combination with availability zone nor scale set. | | `availabilityZone` | int | `0` | `[0, 1, 2, 3]` | If set to 1, 2 or 3, the availability zone for all VMs is hardcoded to that value. If zero, then availability zones is not used. Cannot be used in combination with availability set nor scale set. | @@ -75,7 +75,7 @@ This module deploys one Virtual Machine with one or multiple NICs and optionally | `extensionCustomScriptProtectedSetting` | secureObject | `{object}` | | Any object that contains the extension specific protected settings. | | `extensionDependencyAgentConfig` | object | `{object}` | | The configuration for the [Dependency Agent] extension. Must at least contain the ["enabled": true] property to be executed. | | `extensionDomainJoinConfig` | object | `{object}` | | The configuration for the [Domain Join] extension. Must at least contain the ["enabled": true] property to be executed. | -| `extensionDomainJoinPassword` | secureString | `''` | | Required if name is specified. Password of the user specified in user parameter. | +| `extensionDomainJoinPassword` | securestring | `''` | | Required if name is specified. Password of the user specified in user parameter. | | `extensionDSCConfig` | object | `{object}` | | The configuration for the [Desired State Configuration] extension. Must at least contain the ["enabled": true] property to be executed. | | `extensionMonitoringAgentConfig` | object | `{object}` | | The configuration for the [Monitoring Agent] extension. Must at least contain the ["enabled": true] property to be executed. | | `extensionNetworkWatcherAgentConfig` | object | `{object}` | | The configuration for the [Network Watcher Agent] extension. Must at least contain the ["enabled": true] property to be executed. | diff --git a/modules/Microsoft.DBforPostgreSQL/flexibleServers/readme.md b/modules/Microsoft.DBforPostgreSQL/flexibleServers/readme.md index 23cc3b33e5..eeef5163d3 100644 --- a/modules/Microsoft.DBforPostgreSQL/flexibleServers/readme.md +++ b/modules/Microsoft.DBforPostgreSQL/flexibleServers/readme.md @@ -29,7 +29,7 @@ This module deploys DBforPostgreSQL FlexibleServers. | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `administratorLogin` | string | | The administrator login name of a server. Can only be specified when the PostgreSQL server is being created. | -| `administratorLoginPassword` | secureString | | The administrator login password. | +| `administratorLoginPassword` | securestring | | The administrator login password. | | `name` | string | | The name of the PostgreSQL flexible server. | | `skuName` | string | | The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. | | `tier` | string | `[Burstable, GeneralPurpose, MemoryOptimized]` | The tier of the particular SKU. Tier must align with the "skuName" property. Example, tier cannot be "Burstable" if skuName is "Standard_D4s_v3". | diff --git a/modules/Microsoft.DevTestLab/labs/artifactSources/readme.md b/modules/Microsoft.DevTestLab/labs/artifactSources/readme.md index f62129f177..a1943dd255 100644 --- a/modules/Microsoft.DevTestLab/labs/artifactSources/readme.md +++ b/modules/Microsoft.DevTestLab/labs/artifactSources/readme.md @@ -41,7 +41,7 @@ An artifact source allows you to create custom artifacts for the VMs in the lab, | `branchRef` | string | `''` | | The artifact source's branch reference (e.g. main or master). | | `displayName` | string | `[parameters('name')]` | | The artifact source's display name. Default is the name of the artifact source. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | -| `securityToken` | secureString | `''` | | The security token to authenticate to the artifact source. | +| `securityToken` | securestring | `''` | | The security token to authenticate to the artifact source. | | `sourceType` | string | `''` | `['', GitHub, StorageAccount, VsoGit]` | The artifact source's type. | | `status` | string | `'Enabled'` | `[Disabled, Enabled]` | Indicates if the artifact source is enabled (values: Enabled, Disabled). Default is "Enabled". | | `tags` | object | `{object}` | | Tags of the resource. | diff --git a/modules/Microsoft.KeyVault/vaults/secrets/readme.md b/modules/Microsoft.KeyVault/vaults/secrets/readme.md index dbf60f730d..0f910c6020 100644 --- a/modules/Microsoft.KeyVault/vaults/secrets/readme.md +++ b/modules/Microsoft.KeyVault/vaults/secrets/readme.md @@ -23,7 +23,7 @@ This module deploys a key vault secret. | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the secret. | -| `value` | secureString | The value of the secret. NOTE: "value" will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets. | +| `value` | securestring | The value of the secret. NOTE: "value" will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets. | **Conditional parameters** @@ -38,7 +38,7 @@ This module deploys a key vault secret. | `attributesEnabled` | bool | `True` | Determines whether the object is enabled. | | `attributesExp` | int | `-1` | Expiry date in seconds since 1970-01-01T00:00:00Z. For security reasons, it is recommended to set an expiration date whenever possible. | | `attributesNbf` | int | `-1` | Not before date in seconds since 1970-01-01T00:00:00Z. | -| `contentType` | secureString | `''` | The content type of the secret. | +| `contentType` | securestring | `''` | The content type of the secret. | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via a Globally Unique Identifier (GUID). | | `roleAssignments` | array | `[]` | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | | `tags` | object | `{object}` | Resource tags. | diff --git a/modules/Microsoft.NetApp/netAppAccounts/readme.md b/modules/Microsoft.NetApp/netAppAccounts/readme.md index 31a60959dd..6fd17e6122 100644 --- a/modules/Microsoft.NetApp/netAppAccounts/readme.md +++ b/modules/Microsoft.NetApp/netAppAccounts/readme.md @@ -35,7 +35,7 @@ This template deploys Azure NetApp Files. | `capacityPools` | _[capacityPools](capacityPools/readme.md)_ array | `[]` | | Capacity pools to create. | | `dnsServers` | string | `''` | | Required if domainName is specified. Comma separated list of DNS server IP addresses (IPv4 only) required for the Active Directory (AD) domain join and SMB authentication operations to succeed. | | `domainJoinOU` | string | `''` | | Used only if domainName is specified. LDAP Path for the Organization Unit (OU) where SMB Server machine accounts will be created (i.e. 'OU=SecondLevel,OU=FirstLevel'). | -| `domainJoinPassword` | secureString | `''` | | Required if domainName is specified. Password of the user specified in domainJoinUser parameter. | +| `domainJoinPassword` | securestring | `''` | | Required if domainName is specified. Password of the user specified in domainJoinUser parameter. | | `domainJoinUser` | string | `''` | | Required if domainName is specified. Username of Active Directory domain administrator, with permissions to create SMB server machine account in the AD domain. | | `domainName` | string | `''` | | Fully Qualified Active Directory DNS Domain Name (e.g. 'contoso.com'). | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | diff --git a/modules/Microsoft.Network/localNetworkGateways/readme.md b/modules/Microsoft.Network/localNetworkGateways/readme.md index b8cd0db687..1d50b7025b 100644 --- a/modules/Microsoft.Network/localNetworkGateways/readme.md +++ b/modules/Microsoft.Network/localNetworkGateways/readme.md @@ -15,7 +15,7 @@ This module deploys a local network gateway. | Resource Type | API Version | | :-- | :-- | | `Microsoft.Authorization/locks` | [2020-05-01](https://docs.microsoft.com/en-us/azure/templates/Microsoft.Authorization/2020-05-01/locks) | -| `Microsoft.Authorization/roleAssignments` | [2022-04-01](https://docs.microsoft.com/en-us/azure/templates/Microsoft.Authorization/2022-04-01/roleAssignments) | +| `Microsoft.Authorization/roleAssignments` | [2022-04-01](https://docs.microsoft.com/en-us/azure/templates/Microsoft.Authorization/roleAssignments) | | `Microsoft.Network/localNetworkGateways` | [2021-08-01](https://docs.microsoft.com/en-us/azure/templates/Microsoft.Network/2021-08-01/localNetworkGateways) | ## Parameters diff --git a/modules/Microsoft.Sql/managedInstances/readme.md b/modules/Microsoft.Sql/managedInstances/readme.md index a8b02fed4f..6ae4ad196d 100644 --- a/modules/Microsoft.Sql/managedInstances/readme.md +++ b/modules/Microsoft.Sql/managedInstances/readme.md @@ -46,7 +46,7 @@ SQL MI allows for Azure AD Authentication via an [Azure AD Admin](https://docs.m | Parameter Name | Type | Description | | :-- | :-- | :-- | | `administratorLogin` | string | The username used to establish jumpbox VMs. | -| `administratorLoginPassword` | secureString | The password given to the admin user. | +| `administratorLoginPassword` | securestring | The password given to the admin user. | | `name` | string | The name of the SQL managed instance. | | `subnetId` | string | The fully qualified resource ID of the subnet on which the SQL managed instance will be placed. | diff --git a/modules/Microsoft.Sql/servers/readme.md b/modules/Microsoft.Sql/servers/readme.md index 3c6d44eb91..00ffa526f4 100644 --- a/modules/Microsoft.Sql/servers/readme.md +++ b/modules/Microsoft.Sql/servers/readme.md @@ -41,7 +41,7 @@ This module deploys a SQL server. | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `administratorLogin` | string | `''` | The administrator username for the server. Required if no `administrators` object for AAD authentication is provided. | -| `administratorLoginPassword` | secureString | `''` | The administrator login password. Required if no `administrators` object for AAD authentication is provided. | +| `administratorLoginPassword` | securestring | `''` | The administrator login password. Required if no `administrators` object for AAD authentication is provided. | | `administrators` | object | `{object}` | The Azure Active Directory (AAD) administrator authentication. Required if no `administratorLogin` & `administratorLoginPassword` is provided. | | `primaryUserAssignedIdentityId` | string | `''` | The resource ID of a user assigned identity to be used by default. Required if "userAssignedIdentities" is not empty. | diff --git a/modules/Microsoft.Sql/servers/securityAlertPolicies/readme.md b/modules/Microsoft.Sql/servers/securityAlertPolicies/readme.md index ab8202d989..33426b8907 100644 --- a/modules/Microsoft.Sql/servers/securityAlertPolicies/readme.md +++ b/modules/Microsoft.Sql/servers/securityAlertPolicies/readme.md @@ -39,7 +39,7 @@ This module deploys an SQL Server Security Alert Policy. | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | | `retentionDays` | int | `0` | | Specifies the number of days to keep in the Threat Detection audit logs. | | `state` | string | `'Disabled'` | `[Disabled, Enabled]` | Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. | -| `storageAccountAccessKey` | secureString | `''` | | Specifies the identifier key of the Threat Detection audit storage account.. | +| `storageAccountAccessKey` | securestring | `''` | | Specifies the identifier key of the Threat Detection audit storage account.. | | `storageEndpoint` | string | `''` | | Specifies the blob storage endpoint. This blob storage will hold all Threat Detection audit logs. | diff --git a/modules/Microsoft.Web/staticSites/readme.md b/modules/Microsoft.Web/staticSites/readme.md index d3a8475ce8..bf2d6cb7ac 100644 --- a/modules/Microsoft.Web/staticSites/readme.md +++ b/modules/Microsoft.Web/staticSites/readme.md @@ -48,7 +48,7 @@ This module deploys a Static Web App. | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `privateEndpoints` | array | `[]` | | Configuration details for private endpoints. For security reasons, it is recommended to use private endpoints whenever possible. Note, requires the 'sku' to be 'Standard'. | | `provider` | string | `'None'` | | The provider that submitted the last deployment to the primary environment of the static site. | -| `repositoryToken` | secureString | `''` | | The Personal Access Token for accessing the GitHub repository. | +| `repositoryToken` | securestring | `''` | | The Personal Access Token for accessing the GitHub repository. | | `repositoryUrl` | string | `''` | | The name of the GitHub repository. | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | | `sku` | string | `'Free'` | `[Free, Standard]` | Type of static site to deploy. |