Microsoft.AppConfiguration (stable:2023-11-01)

2024/12/06 • 2 updated methods

GetKeyValue (updated)
Description :  Gets a single key-value.
Reference :  Link ¶

⚶ Changes

{
  "#id": "GetKeyValue",
  "$responses": {
    "200": [
      {
        "@added_9d0676fe09534b298fc33d0ff3525c2f": {
          "#name": "x-ms-request-id",
          "Description": "An opaque, globally-unique, server-generated string identifier for the request.",
          "Type": "string"
        }
      },
      {
        "@removed_6a2ae6d5cec746d2a489b26c30886413": {
          "#name": "x-ms-client-request-id",
          "Description": "An opaque, globally-unique, client-generated string identifier for the request.",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

GET:  /kv/{key}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
key:
{
Description: The key of the key-value. ,
Required: True ,
}
string ,
label:
{
Description: The label of the key-value to retrieve. ,
Required: False ,
}
string ,
$Select:
{
Description: Used to select what fields are present in the returned resource(s). ,
Required: False ,
}
array ,
Sync-Token:
{
Description: Used to guarantee real-time consistency between requests. ,
Required: False ,
}
string ,
Accept-Datetime:
{
Description: Requests the server to respond with the state of the resource at the specified time. ,
Required: False ,
}
string ,
If-Match:
{
Description: Used to perform an operation only if the targeted resource's etag matches the value provided. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Used to perform an operation only if the targeted resource's etag does not match the value provided. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: A value representing the current state of the resource. ,
}
string ,
sync-token:
{
Description: Used to guarantee real-time consistency between requests. ,
}
string ,
x-ms-request-id:
{
Description: An opaque, globally-unique, server-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: A key-value pair representing application settings. ,
}
{
key:
{
Description: The key of the key-value. ,
Required: True ,
}
string ,
label:
{
Description: The label the key-value belongs to. ,
Required: False ,
}
string ,
content_type:
{
Description: The content type of the value stored within the key-value. ,
Required: False ,
}
string ,
value:
{
Description: The value of the key-value. ,
Required: False ,
}
string ,
last_modified:
{
Description: A date representing the last time the key-value was modified. ,
Format: date-time ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the key-value ,
Required: False ,
}
object ,
locked:
{
Description: Indicates whether the key-value is locked. ,
Required: False ,
}
boolean ,
etag:
{
Description: A value representing the current state of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
type:
{
Description: The type of the error. ,
Required: False ,
}
string ,
title:
{
Description: A brief summary of the error. ,
Required: False ,
}
string ,
name:
{
Description: The name of the parameter that resulted in the error. ,
Required: False ,
}
string ,
detail:
{
Description: A detailed description of the error. ,
Required: False ,
}
string ,
status:
{
Description: The HTTP status code that the error maps to. ,
Format: int32 ,
Required: False ,
}
integer ,
}
GetSnapshot (updated)
Description :  Gets a single key-value snapshot.
Reference :  Link ¶

⚶ Changes

{
  "#id": "GetSnapshot",
  "$responses": {
    "200": [
      {
        "@added_6cbf8096aa9e483a9badc5014393ae0b": {
          "#name": "x-ms-request-id",
          "Description": "An opaque, globally-unique, server-generated string identifier for the request.",
          "Type": "string"
        }
      },
      {
        "@removed_33719723ecb94da18500c73f72231c2a": {
          "#name": "x-ms-client-request-id",
          "Description": "An opaque, globally-unique, client-generated string identifier for the request.",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

GET:  /snapshots/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the snapshot. ,
Required: True ,
}
string ,
$Select:
{
Description: Used to select what fields are present in the returned resource(s). ,
Required: False ,
}
array ,
Sync-Token:
{
Description: Used to guarantee real-time consistency between requests. ,
Required: False ,
}
string ,
If-Match:
{
Description: Used to perform an operation only if the targeted resource's etag matches the value provided. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Used to perform an operation only if the targeted resource's etag does not match the value provided. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: A value representing the current state of the resource. ,
}
string ,
link:
{
Description: Includes links to related resources. ,
}
string ,
sync-token:
{
Description: Used to guarantee real-time consistency between requests. ,
}
string ,
x-ms-request-id:
{
Description: An opaque, globally-unique, server-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: A snapshot is a named, immutable subset of an App Configuration store's key-values. ,
}
{
name:
{
Description: The name of the snapshot. ,
Required: True ,
}
string ,
status:
{
Description: The current status of the snapshot. ,
Enum:
{
provisioning: Provisioning ,
ready: Ready ,
archived: Archived ,
failed: Failed ,
}
,
Required: False ,
}
enum ,
filters:
{
Description: A list of filters used to filter the key-values included in the snapshot. ,
Required: True ,
}
[
{
key:
{
Description: Filters key-values by their key field. ,
Required: True ,
}
string ,
label:
{
Description: Filters key-values by their label field. ,
Required: False ,
}
string ,
tags:
{
Description: Filters key-values by their tags field. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
composition_type:
{
Description: The composition type describes how the key-values within the snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label. ,
Enum:
{
key: The 'key' composition type. ,
key_label: The 'key_label' composition type. ,
}
,
Required: False ,
}
enum ,
created:
{
Description: The time that the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
expires:
{
Description: The time that the snapshot will expire. ,
Format: date-time ,
Required: False ,
}
string ,
retention_period:
{
Description: The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used. ,
Format: int64 ,
Required: False ,
}
integer ,
size:
{
Description: The size in bytes of the snapshot. ,
Format: int64 ,
Required: False ,
}
integer ,
items_count:
{
Description: The amount of key-values in the snapshot. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: The tags of the snapshot. ,
Required: False ,
}
object ,
etag:
{
Description: A value representing the current state of the snapshot. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
type:
{
Description: The type of the error. ,
Required: False ,
}
string ,
title:
{
Description: A brief summary of the error. ,
Required: False ,
}
string ,
name:
{
Description: The name of the parameter that resulted in the error. ,
Required: False ,
}
string ,
detail:
{
Description: A detailed description of the error. ,
Required: False ,
}
string ,
status:
{
Description: The HTTP status code that the error maps to. ,
Format: int32 ,
Required: False ,
}
integer ,
}