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

2025/09/05 • 21 deleted methods

GetKeys (removed)
Description :  Gets a list of keys.
Reference :  Link ¶

⚼ Request

GET:  /keys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: A filter for the name of the returned keys. ,
Required: False ,
}
string ,
After:
{
Description: Instructs the server to return elements that appear after the element referred to by the specified token. ,
Required: False ,
}
string ,
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 ,
}

⚐ Response (200)

{
$headers:
{
sync-token:
{
Description: Used to guarantee real-time consistency between requests. ,
}
string ,
}
,
$schema:
{
Description: The result of a list request. ,
}
{
items:
{
Description: The collection value. ,
Required: False ,
}
[
{
name:
{
Description: The name of the key. ,
Required: True ,
}
string ,
}
,
]
,
@nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
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 ,
}
CheckKeys (removed)
Description :  Requests the headers and status of the given resource.
Reference :  Link ¶

⚼ Request

HEAD:  /keys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: A filter for the name of the returned keys. ,
Required: False ,
}
string ,
After:
{
Description: Instructs the server to return elements that appear after the element referred to by the specified token. ,
Required: False ,
}
string ,
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 ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
sync-token:
{
Description: Used to guarantee real-time consistency between requests. ,
}
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 ,
}
GetKeyValues (removed)
Description :  Gets a list of key-values.
Reference :  Link ¶

⚼ Request

GET:  /kv
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
key:
{
Description: A filter used to match keys. Syntax reference: https://aka.ms/azconfig/docs/keyvaluefiltering ,
Required: False ,
}
string ,
label:
{
Description: A filter used to match labels. Syntax reference: https://aka.ms/azconfig/docs/keyvaluefiltering ,
Required: False ,
}
string ,
Sync-Token:
{
Description: Used to guarantee real-time consistency between requests. ,
Required: False ,
}
string ,
After:
{
Description: Instructs the server to return elements that appear after the element referred to by the specified token. ,
Required: False ,
}
string ,
Accept-Datetime:
{
Description: Requests the server to respond with the state of the resource at the specified time. ,
Required: False ,
}
string ,
$Select:
{
Description: Used to select what fields are present in the returned resource(s). ,
Required: False ,
}
array ,
snapshot:
{
Description: A filter used get key-values for a snapshot. The value should be the name of the snapshot. Not valid when used with 'key' and 'label' filters. ,
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 ,
tags:
{
Description: A filter used to query by tags. Syntax reference: https://aka.ms/azconfig/docs/keyvaluefiltering ,
Required: False ,
}
array ,
}

⚐ 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 ,
}
,
$schema:
{
Description: The result of a list request. ,
}
{
items:
{
Description: The collection value. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
etag:
{
Description: An identifier representing the returned state of the resource. ,
Required: False ,
}
string ,
@nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
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 ,
}
CheckKeyValues (removed)
Description :  Requests the headers and status of the given resource.
Reference :  Link ¶

⚼ Request

HEAD:  /kv
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
key:
{
Description: A filter used to match keys. Syntax reference: https://aka.ms/azconfig/docs/keyvaluefiltering ,
Required: False ,
}
string ,
label:
{
Description: A filter used to match labels. Syntax reference: https://aka.ms/azconfig/docs/keyvaluefiltering ,
Required: False ,
}
string ,
Sync-Token:
{
Description: Used to guarantee real-time consistency between requests. ,
Required: False ,
}
string ,
After:
{
Description: Instructs the server to return elements that appear after the element referred to by the specified token. ,
Required: False ,
}
string ,
Accept-Datetime:
{
Description: Requests the server to respond with the state of the resource at the specified time. ,
Required: False ,
}
string ,
$Select:
{
Description: Used to select what fields are present in the returned resource(s). ,
Required: False ,
}
array ,
snapshot:
{
Description: A filter used get key-values for a snapshot. The value should be the name of the snapshot. Not valid when used with 'key' and 'label' filters. ,
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 ,
tags:
{
Description: A filter used to query by tags. Syntax reference: https://aka.ms/azconfig/docs/keyvaluefiltering ,
Required: False ,
}
array ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: A value representing the current state of the resource. ,
}
string ,
sync-token:
{
Description: Used to guarantee real-time consistency between requests. ,
}
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 ,
}
GetKeyValue (removed)
Description :  Gets a single key-value.
Reference :  Link ¶

⚼ 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 ,
}
PutKeyValue (removed)
Description :  Creates a key-value.
Reference :  Link ¶

⚼ Request

PUT:  /kv/{key}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
key:
{
Description: The key of the key-value to create. ,
Required: True ,
}
string ,
label:
{
Description: The label of the key-value to create. ,
Required: False ,
}
string ,
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 ,
entity:
{
Description: The key-value to create. ,
Required: False ,
}
{
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 (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 ,
}
,
$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 ,
}
DeleteKeyValue (removed)
Description :  Deletes a key-value.
Reference :  Link ¶

⚼ Request

DELETE:  /kv/{key}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
key:
{
Description: The key of the key-value to delete. ,
Required: True ,
}
string ,
label:
{
Description: The label of the key-value to delete. ,
Required: False ,
}
string ,
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 ,
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 ,
}
,
$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 (204)

{
sync-token:
{
Description: Used to guarantee real-time consistency between requests. ,
}
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 ,
}
CheckKeyValue (removed)
Description :  Requests the headers and status of the given resource.
Reference :  Link ¶

⚼ Request

HEAD:  /kv/{key}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
key:
{
Description: The key of the key-value to retrieve. ,
Required: True ,
}
string ,
label:
{
Description: The label of the key-value to retrieve. ,
Required: False ,
}
string ,
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 ,
$Select:
{
Description: Used to select what fields are present in the returned resource(s). ,
Required: False ,
}
array ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: A value representing the current state of the resource. ,
}
string ,
sync-token:
{
Description: Used to guarantee real-time consistency between requests. ,
}
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 ,
}
GetLabels (removed)
Description :  Gets a list of labels.
Reference :  Link ¶

⚼ Request

GET:  /labels
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: A filter for the name of the returned labels. ,
Required: False ,
}
string ,
Sync-Token:
{
Description: Used to guarantee real-time consistency between requests. ,
Required: False ,
}
string ,
After:
{
Description: Instructs the server to return elements that appear after the element referred to by the specified token. ,
Required: False ,
}
string ,
Accept-Datetime:
{
Description: Requests the server to respond with the state of the resource at the specified time. ,
Required: False ,
}
string ,
$Select:
{
Description: Used to select what fields are present in the returned resource(s). ,
Required: False ,
}
array ,
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:
{
sync-token:
{
Description: Used to guarantee real-time consistency between requests. ,
}
string ,
}
,
$schema:
{
Description: The result of a list request. ,
}
{
items:
{
Description: The collection value. ,
Required: False ,
}
[
{
name:
{
Description: The name of the label. ,
Required: False ,
}
string ,
}
,
]
,
@nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
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 ,
}
CheckLabels (removed)
Description :  Requests the headers and status of the given resource.
Reference :  Link ¶

⚼ Request

HEAD:  /labels
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: A filter for the name of the returned labels. ,
Required: False ,
}
string ,
Sync-Token:
{
Description: Used to guarantee real-time consistency between requests. ,
Required: False ,
}
string ,
After:
{
Description: Instructs the server to return elements that appear after the element referred to by the specified token. ,
Required: False ,
}
string ,
Accept-Datetime:
{
Description: Requests the server to respond with the state of the resource at the specified time. ,
Required: False ,
}
string ,
$Select:
{
Description: Used to select what fields are present in the returned resource(s). ,
Required: False ,
}
array ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
sync-token:
{
Description: Used to guarantee real-time consistency between requests. ,
}
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 ,
}
PutLock (removed)
Description :  Locks a key-value.
Reference :  Link ¶

⚼ Request

PUT:  /locks/{key}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
key:
{
Description: The key of the key-value to lock. ,
Required: True ,
}
string ,
label:
{
Description: The label, if any, of the key-value to lock. ,
Required: False ,
}
string ,
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 ,
sync-token:
{
Description: Used to guarantee real-time consistency between requests. ,
}
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 ,
}
DeleteLock (removed)
Description :  Unlocks a key-value.
Reference :  Link ¶

⚼ Request

DELETE:  /locks/{key}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
key:
{
Description: The key of the key-value to unlock. ,
Required: True ,
}
string ,
label:
{
Description: The label, if any, of the key-value to unlock. ,
Required: False ,
}
string ,
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 ,
sync-token:
{
Description: Used to guarantee real-time consistency between requests. ,
}
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 ,
}
GetOperationDetails (removed)
Description :  Gets the state of a long running operation.
Reference :  Link ¶

⚼ Request

GET:  /operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
snapshot:
{
Description: Snapshot identifier for the long running operation. ,
Required: True ,
}
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)

{
id:
{
Description: The unique id of the operation. ,
Required: True ,
}
string ,
status:
{
Description: The current status of the operation ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: An error, available when the status is `Failed`, describing why the operation failed. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
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 ,
}
GetRevisions (removed)
Description :  Gets a list of key-value revisions.
Reference :  Link ¶

⚼ Request

GET:  /revisions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
key:
{
Description: A filter used to match keys. Syntax reference: https://aka.ms/azconfig/docs/restapirevisions ,
Required: False ,
}
string ,
label:
{
Description: A filter used to match labels. Syntax reference: https://aka.ms/azconfig/docs/restapirevisions ,
Required: False ,
}
string ,
Sync-Token:
{
Description: Used to guarantee real-time consistency between requests. ,
Required: False ,
}
string ,
After:
{
Description: Instructs the server to return elements that appear after the element referred to by the specified token. ,
Required: False ,
}
string ,
Accept-Datetime:
{
Description: Requests the server to respond with the state of the resource at the specified time. ,
Required: False ,
}
string ,
$Select:
{
Description: Used to select what fields are present in the returned resource(s). ,
Required: False ,
}
array ,
tags:
{
Description: A filter used to query by tags. Syntax reference: https://aka.ms/azconfig/docs/restapirevisions ,
Required: False ,
}
array ,
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 ,
}
,
$schema:
{
Description: The result of a list request. ,
}
{
items:
{
Description: The collection value. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
etag:
{
Description: An identifier representing the returned state of the resource. ,
Required: False ,
}
string ,
@nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
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 ,
}
CheckRevisions (removed)
Description :  Requests the headers and status of the given resource.
Reference :  Link ¶

⚼ Request

HEAD:  /revisions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
key:
{
Description: A filter used to match keys. Syntax reference: https://aka.ms/azconfig/docs/restapirevisions ,
Required: False ,
}
string ,
label:
{
Description: A filter used to match labels. Syntax reference: https://aka.ms/azconfig/docs/restapirevisions ,
Required: False ,
}
string ,
Sync-Token:
{
Description: Used to guarantee real-time consistency between requests. ,
Required: False ,
}
string ,
After:
{
Description: Instructs the server to return elements that appear after the element referred to by the specified token. ,
Required: False ,
}
string ,
Accept-Datetime:
{
Description: Requests the server to respond with the state of the resource at the specified time. ,
Required: False ,
}
string ,
$Select:
{
Description: Used to select what fields are present in the returned resource(s). ,
Required: False ,
}
array ,
tags:
{
Description: A filter used to query by tags. Syntax reference: https://aka.ms/azconfig/docs/restapirevisions ,
Required: False ,
}
array ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: A value representing the current state of the resource. ,
}
string ,
sync-token:
{
Description: Used to guarantee real-time consistency between requests. ,
}
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 ,
}
GetSnapshots (removed)
Description :  Gets a list of key-value snapshots.
Reference :  Link ¶

⚼ Request

GET:  /snapshots
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: A filter for the name of the returned snapshots. ,
Required: False ,
}
string ,
After:
{
Description: Instructs the server to return elements that appear after the element referred to by the specified token. ,
Required: False ,
}
string ,
$Select:
{
Description: Used to select what fields are present in the returned resource(s). ,
Required: False ,
}
array ,
status:
{
Description: Used to filter returned snapshots by their status property. ,
Required: False ,
}
array ,
Sync-Token:
{
Description: Used to guarantee real-time consistency between requests. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
sync-token:
{
Description: Used to guarantee real-time consistency between requests. ,
}
string ,
}
,
$schema:
{
Description: The result of a snapshot list request. ,
}
{
items:
{
Description: The collection value. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
@nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
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 ,
}
CheckSnapshots (removed)
Description :  Requests the headers and status of the given resource.
Reference :  Link ¶

⚼ Request

HEAD:  /snapshots
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
Sync-Token:
{
Description: Used to guarantee real-time consistency between requests. ,
Required: False ,
}
string ,
After:
{
Description: Instructs the server to return elements that appear after the element referred to by the specified token. ,
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)

{
sync-token:
{
Description: Used to guarantee real-time consistency between requests. ,
}
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 (removed)
Description :  Gets a single key-value snapshot.
Reference :  Link ¶

⚼ 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 ,
}
CreateSnapshot (removed)
Description :  Creates a key-value snapshot.
Reference :  Link ¶

⚼ Request

PUT:  /snapshots/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the key-value snapshot to create. ,
Required: True ,
}
string ,
Sync-Token:
{
Description: Used to guarantee real-time consistency between requests. ,
Required: False ,
}
string ,
entity:
{
Description: The key-value snapshot to create. ,
Required: True ,
}
{
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 (201)

{
$headers:
{
etag:
{
Description: A value representing the current state of the resource. ,
}
string ,
link:
{
Description: Includes links to related resources. ,
}
string ,
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
sync-token:
{
Description: Used to guarantee real-time consistency between requests. ,
}
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 ,
}
UpdateSnapshot (removed)
Description :  Updates the state of a key-value snapshot.
Reference :  Link ¶

⚼ Request

PATCH:  /snapshots/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the key-value snapshot to update. ,
Required: True ,
}
string ,
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 ,
entity:
{
Description: The parameters used to update the snapshot. ,
Required: True ,
}
{
status:
{
Description: The desired status of the snapshot. ,
Enum:
{
provisioning: Provisioning ,
ready: Ready ,
archived: Archived ,
failed: Failed ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
$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 ,
}
CheckSnapshot (removed)
Description :  Requests the headers and status of the given resource.
Reference :  Link ¶

⚼ Request

HEAD:  /snapshots/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the key-value snapshot to check. ,
Required: True ,
}
string ,
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)

{
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 ,
}

⚐ 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 ,
}