AzureAppConfigurationSnapshot@1 - Azure App Configuration Snapshot v1 task

Raksts
08/26/2024

Create a snapshot in an Azure App Configuration instance.

Syntax

# Azure App Configuration Snapshot v1
# Create a snapshot in an Azure App Configuration instance.
- task: AzureAppConfigurationSnapshot@1
  inputs:
  # AppConfiguration
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure subscription. 
    AppConfigurationEndpoint: # string. Required. App Configuration Endpoint. 
  # Options
    SnapshotName: # string. Required. Snapshot Name. 
    CompositionType: 'key' # 'key' | 'key_label'. Required. Composition Type. Default: key.
    Filters: # string. Required. Filters for key-values. 
    #RetentionPeriod: '30' # string. Days to retain archived snapshot. Default: 30.
    #Tags: # string. Tags.

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.

SnapshotName - Snapshot Name
string. Required.

Provide a name for the snapshot.

CompositionType - Composition Type
string. Required. Allowed values: key (Key (default)), key_label (Key-Label). Default value: key.

Key (key): The filters are applied in order for this composition type. Each key value in the snapshot is uniquely identified by the key only. If there are multiple key values with the same key and multiple labels, only one key value will be retained based on the last applicable filter.
Key-Label (key_label): Filters will be applied and every key value in the resulting snapshot will be uniquely identified by the key and label together.

Filters - Filters for key-values
string. Required.

Specifies snapshot filters that represent the key and label filters used to build an App Configuration snapshot. Filters should be of a valid JSON format. Example [{"key":"abc*", "label":"1.0.0"}]. At least 1 filter and max of 3 filters can be applied.

RetentionPeriod - Days to retain archived snapshot
string. Default value: 30.

Archived snapshots can be recovered during the retention period. Choose the number of days the snapshot will be retained after it is archived. The value cannot be changed after creation.

Tags - Tags
string.

Specifies one or more tags that should be added to a snapshot. Tags should be of a valid JSON format and can span multiple lines. Example: {"tag1": "value1", "tag2": "value2"}.

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.

Remarks

This task is used for creating snapshots in a given App Configuration store. A snapshot is a named, immutable subset of an App Configuration store's key-values. The task is node based and works on cross platform Azure Pipelines agents running Windows, Linux or Mac.

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

Kopīgot, izmantojot