Muokkaa

Jaa

AzureAppConfigurationImport@10 - Azure App Configuration Import v10 task

  • Artikkeli

Import key-values to an Azure App Configuration instance.

Syntax

# Azure App Configuration Import v10
# Import key-values to an Azure App Configuration instance.
- task: AzureAppConfigurationImport@10
  inputs:
  # AppConfiguration
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure subscription. 
    AppConfigurationEndpoint: # string. Required. App Configuration Endpoint. 
  # Source
    ConfigurationFile: # string. Required. Configuration File Path. 
    #UseFilePathExtension: true # boolean. Use the file path extension to determine the file format. Default: true.
    #FileFormat: # 'json' | 'yaml' | 'properties'. Optional. Use when UseFilePathExtension = false. File Format. 
  # Options
    #FileContentProfile: 'appconfig/default' # 'appconfig/default' | 'appconfig/kvset'. File Content Profile. Default: appconfig/default.
    #Separator: # '.' | '/' | ':' | ';' | ' |' | '-' | '_' | '__'. Optional. Use when FileContentProfile = appconfig/default. Separator. 
    #Depth: # string. Optional. Use when FileContentProfile = appconfig/default. Depth. 
    #Prefix: # string. Optional. Use when FileContentProfile = appconfig/default. Prefix. 
    #Label: # string. Optional. Use when FileContentProfile = appconfig/default. Label. 
    #ContentType: # string. Optional. Use when FileContentProfile = appconfig/default. Content Type. 
    #Tags: # string. Optional. Use when FileContentProfile = appconfig/default. Tags. 
    #ExcludeFeatureFlags: false # boolean. Optional. Use when FileContentProfile = appconfig/default. Exclude feature flags. Default: false.
    #Strict: false # boolean. Delete key-values that are not included in the configuration file. Default: false.
    #DryRun: false # boolean. Dry run. Default: false.
    #ImportMode: 'Ignore-Match' # 'All' | 'Ignore-Match'. Import Mode. Default: Ignore-Match.

Inputs

azureSubscription - Azure subscription
Input alias: ConnectedServiceName. string. Required.

Select the Azure Subscription for the Azure App Configuration instance.


AppConfigurationEndpoint - App Configuration Endpoint
string. Required.

Provide the endpoint of an existing Azure App Configuration.


ConfigurationFile - Configuration File Path
string. Required.

The path to the configuration file (supported: yaml, json, properties).


UseFilePathExtension - Use the file path extension to determine the file format
boolean. Default value: true.

Specifies whether or not to use the file path extension to determine the file format.


FileFormat - File Format
string. Optional. Use when UseFilePathExtension = false. Allowed values: json, yaml, properties.

The configuration file format. If no format is provided, then the format defaults to the file extension of the configuration file provided.


FileContentProfile - File Content Profile
string. Allowed values: appconfig/default (Default), appconfig/kvset (KVSet). Default value: appconfig/default.

The configuration file's content profile.

  • Default: Refers to the conventional configuration file formats that are directly consumable by applications.
  • KVSet: Refers to a file schema that contains all properties of an App Configuration key-value

Separator - Separator
string. Optional. Use when FileContentProfile = appconfig/default. Allowed values: . (. (Period)), / (/ (Forward Slash)), : (: (Colon)), ; (; (Semicolon)), , (, (Comma)), - (- (Hyphen)), _ (_ (Underscore)), __ (__ (Double Underscore)).

Separator is used to flatten the configuration file (json & yaml files). It is required when the depth provided is greater than 1.


Depth - Depth
string. Optional. Use when FileContentProfile = appconfig/default.

Depth to flatten to in configuration file (json and yaml files).


Prefix - Prefix
string. Optional. Use when FileContentProfile = appconfig/default.

A prefix to append to all keys in the configuration file.


Label - Label
string. Optional. Use when FileContentProfile = appconfig/default.

Specifies a string that's added to each key-value as the label within the App Configuration store.


ContentType - Content Type
string. Optional. Use when FileContentProfile = appconfig/default.

Species a string that is added as the content type to all keys in the configuration file.


Tags - Tags
string. Optional. Use when FileContentProfile = appconfig/default.

Specifies one or more tags that should be added to key-value settings being imported to App Configuration. Tags should be of a valid JSON format and can span multiple lines. Example: {"tag1": "value1", "tag2": "value2"}.


ExcludeFeatureFlags - Exclude feature flags
boolean. Optional. Use when FileContentProfile = appconfig/default. Default value: false.

Specifies whether or not any feature flags provided in the configuration file will be imported to App Configuration.


Strict - Delete key-values that are not included in the configuration file
boolean. Default value: false.

The behavior of this option depends on the configuration file's content profile.

  • When false: Imports all key-values from the configuration file into the App Configuration store and leaves everything else in the App Configuration store intact.
  • When true:
    • Default: Any key-values in the store with the specified prefix and label that are not included in the configuration file will be deleted.
    • KVSet: Any key-values in the store that are not included in the configuration file will be deleted.

DryRun - Dry run
boolean. Default value: false.

When dry run is enabled, this task will not perform any updates to App Configuration. Instead, any updates that would have been performed in a normal run will be printed to the console for review.


ImportMode - Import Mode
string. Allowed values: All, Ignore-Match. Default value: Ignore-Match.

Determines the behavior when importing key-values. The default value of Ignore-Match will only import settings that have no matching key-value in App Configuration. All will import all key-values in the input file to App Configuration.


Task control options

All tasks have control options in addition to their task inputs. For more information, see Control options and common task properties.

Output variables

None.

Requirements

Requirement Description
Pipeline types YAML, Classic build, Classic release
Runs on Agent, DeploymentGroup
Demands None
Capabilities This task does not satisfy any demands for subsequent tasks in the job.
Command restrictions Any
Settable variables Any
Agent version 2.144.0 or greater
Task category Utility