Merge pull request #284 from daviwil/update-scenario-yaml
Fix recursive loop when checking for unnecessary allOf usage
This commit is contained in:
David Wilson
GitHub
Коммит
08f6883f74
|
|
@ -273,18 +273,13 @@ export class QualityPreChecker {
|
|||
this.input = JSON.parse(text.replace(new RegExp(`"\\#\\/components\\/schemas\\/${key}"`, 'g'), `"${$ref}"`));
|
||||
const location = schema['x-ms-metadata'].originalLocations[0].replace(/^.*\//, '')
|
||||
if (schema['x-internal-autorest-anonymous-schema']) {
|
||||
delete schemas[key];
|
||||
this.session.warning(`An anonymous inline schema for property '${location.replace(/-/g, '.')}' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code. Don't do that. - removing.`, ['PreCheck', 'AllOfWhenYouMeantRef']);
|
||||
} else {
|
||||
// NOTE: Disabled removing of non-anonymous schema for now until
|
||||
// it has been discussed in Azure/autorest.modelerfour#278
|
||||
this.session.warning(`Schema '${location}' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.`, ['PreCheck', 'AllOfWhenYouMeantRef']);
|
||||
continue;
|
||||
}
|
||||
|
||||
delete schemas[key];
|
||||
|
||||
this.fixUpSchemasThatUseAllOfInsteadOfJustRef()
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1757,32 +1757,6 @@ schemas: !<!Schemas>
|
|||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: '2016-02-29'
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_62
|
||||
serializedName: propBH1
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: propBH1
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: MyBaseHelperType
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_37
|
||||
- *ref_40
|
||||
- *ref_43
|
||||
|
|
|
|||
|
|
@ -1757,32 +1757,6 @@ schemas: !<!Schemas>
|
|||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: '2016-02-29'
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_62
|
||||
serializedName: propBH1
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: propBH1
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: MyBaseHelperType
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_37
|
||||
- *ref_40
|
||||
- *ref_43
|
||||
|
|
|
|||
|
|
@ -1757,32 +1757,6 @@ schemas: !<!Schemas>
|
|||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: '2016-02-29'
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_62
|
||||
serializedName: propBH1
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: propBH1
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: MyBaseHelperType
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_37
|
||||
- *ref_40
|
||||
- *ref_43
|
||||
|
|
|
|||
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
|
|
@ -280,49 +280,6 @@ schemas: !<!Schemas>
|
|||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_1
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 1.0.0
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_8
|
||||
serializedName: pname
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: pname
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_9
|
||||
serializedName: lsize
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: lsize
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_10
|
||||
serializedName: provisioningState
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningState
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: FlattenedResourceProperties
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema> &ref_22
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
|
|||
|
|
@ -280,49 +280,6 @@ schemas: !<!Schemas>
|
|||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_1
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 1.0.0
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_8
|
||||
serializedName: pname
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: pname
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_9
|
||||
serializedName: lsize
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: lsize
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_10
|
||||
serializedName: provisioningState
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningState
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: FlattenedResourceProperties
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema> &ref_22
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
|
|||
|
|
@ -280,49 +280,6 @@ schemas: !<!Schemas>
|
|||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_1
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 1.0.0
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_8
|
||||
serializedName: pname
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: pname
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_9
|
||||
serializedName: lsize
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: lsize
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_10
|
||||
serializedName: provisioningState
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningState
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: FlattenedResourceProperties
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema> &ref_22
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
|
|||
|
|
@ -280,49 +280,6 @@ schemas: !<!Schemas>
|
|||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_1
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 1.0.0
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_8
|
||||
serializedName: pname
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: pname
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_9
|
||||
serializedName: lsize
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: lsize
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_10
|
||||
serializedName: provisioningState
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningState
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: FlattenedResourceProperties
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema> &ref_22
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
|
|||
|
|
@ -280,49 +280,6 @@ schemas: !<!Schemas>
|
|||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_1
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 1.0.0
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_8
|
||||
serializedName: pname
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: pname
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_9
|
||||
serializedName: lsize
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: lsize
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_10
|
||||
serializedName: provisioningState
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningState
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: FlattenedResourceProperties
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema> &ref_22
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
|
|||
|
|
@ -280,49 +280,6 @@ schemas: !<!Schemas>
|
|||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_1
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 1.0.0
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_8
|
||||
serializedName: pname
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: pname
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_9
|
||||
serializedName: lsize
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: lsize
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_10
|
||||
serializedName: provisioningState
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningState
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: FlattenedResourceProperties
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema> &ref_22
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
|
|||
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
|
|
@ -1762,32 +1762,6 @@ schemas: !<!Schemas>
|
|||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: '2016-02-29'
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_62
|
||||
serializedName: propBH1
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: propBH1
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: MyBaseHelperType
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_37
|
||||
- *ref_40
|
||||
- *ref_43
|
||||
|
|
|
|||
|
|
@ -1762,32 +1762,6 @@ schemas: !<!Schemas>
|
|||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: '2016-02-29'
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_62
|
||||
serializedName: propBH1
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: propBH1
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: MyBaseHelperType
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_37
|
||||
- *ref_40
|
||||
- *ref_43
|
||||
|
|
|
|||
|
|
@ -1762,32 +1762,6 @@ schemas: !<!Schemas>
|
|||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: '2016-02-29'
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_62
|
||||
serializedName: propBH1
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: propBH1
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: MyBaseHelperType
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_37
|
||||
- *ref_40
|
||||
- *ref_43
|
||||
|
|
|
|||
|
|
@ -187,8 +187,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: number
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even
|
||||
for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!NumberSchema> &ref_66
|
||||
type: integer
|
||||
|
|
@ -378,8 +378,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: SearchRequest-searchFields
|
||||
description: >-
|
||||
The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over
|
||||
any field names listed in this parameter.
|
||||
The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence
|
||||
over any field names listed in this parameter.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!StringSchema> &ref_22
|
||||
type: string
|
||||
|
|
@ -985,8 +985,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even
|
||||
for services with only one replica. The default is 100.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 100.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_15
|
||||
|
|
@ -995,9 +995,9 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: OrderBy
|
||||
description: >-
|
||||
The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be
|
||||
followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending
|
||||
by document match score. There can be at most 32 $orderby clauses.
|
||||
The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression
|
||||
can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is
|
||||
descending by document match score. There can be at most 32 $orderby clauses.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_16
|
||||
|
|
@ -1018,16 +1018,16 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: SearchRequest-scoringParameters
|
||||
description: >-
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation'
|
||||
the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called
|
||||
'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
protocol: !<!Protocols> {}
|
||||
serializedName: scoringParameters
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: scoringParameters
|
||||
description: >-
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation'
|
||||
the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called
|
||||
'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_18
|
||||
|
|
@ -1052,8 +1052,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: searchFields
|
||||
description: >-
|
||||
The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence
|
||||
over any field names listed in this parameter.
|
||||
The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take
|
||||
precedence over any field names listed in this parameter.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_21
|
||||
|
|
@ -1078,8 +1078,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: skip
|
||||
description: >-
|
||||
The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use skip due to this limitation, consider using orderby on a totally-ordered key and
|
||||
filter with a range query instead.
|
||||
The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use skip due to this limitation, consider using orderby on a totally-ordered key
|
||||
and filter with a range query instead.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_24
|
||||
|
|
@ -1108,8 +1108,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: NextPageParameters
|
||||
description: >-
|
||||
Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get
|
||||
the next part of the search response.
|
||||
Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to
|
||||
get the next part of the search response.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: !<!ArraySchema> &ref_77
|
||||
|
|
@ -1177,8 +1177,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: NextLink
|
||||
description: >-
|
||||
Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search
|
||||
response. Make sure to use the same verb (GET or POST) as the request that produced this response.
|
||||
Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the
|
||||
search response. Make sure to use the same verb (GET or POST) as the request that produced this response.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -1314,8 +1314,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even
|
||||
for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_15
|
||||
|
|
@ -1325,8 +1325,8 @@ schemas: !<!Schemas>
|
|||
name: OrderBy
|
||||
description: >-
|
||||
The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be
|
||||
followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by
|
||||
document match score. There can be at most 32 $orderby clauses.
|
||||
followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending
|
||||
by document match score. There can be at most 32 $orderby clauses.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_41
|
||||
|
|
@ -1497,8 +1497,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: statusCode
|
||||
description: >-
|
||||
The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a
|
||||
version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy.
|
||||
The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for
|
||||
a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -1639,8 +1639,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: UseFuzzyMatching
|
||||
description: >-
|
||||
A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will autocomplete terms even if there's a substituted or missing character in the search text. While this
|
||||
provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.
|
||||
A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will autocomplete terms even if there's a substituted or missing character in the search text. While
|
||||
this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_61
|
||||
|
|
@ -1665,8 +1665,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search
|
||||
availability even for services with only one replica. The default is 80.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_64
|
||||
|
|
@ -2091,8 +2091,8 @@ operationGroups:
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for
|
||||
services with only one replica. The default is 100.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 100.
|
||||
serializedName: minimumCoverage
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2107,9 +2107,9 @@ operationGroups:
|
|||
default:
|
||||
name: OrderBy
|
||||
description: >-
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to
|
||||
indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score.
|
||||
There can be at most 32 $orderby clauses.
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc
|
||||
to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document
|
||||
match score. There can be at most 32 $orderby clauses.
|
||||
serializedName: $orderby
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2138,8 +2138,8 @@ operationGroups:
|
|||
default:
|
||||
name: ScoringParameters
|
||||
description: >-
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the
|
||||
parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation'
|
||||
the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
serializedName: scoringParameter
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2169,8 +2169,8 @@ operationGroups:
|
|||
default:
|
||||
name: searchFields
|
||||
description: >-
|
||||
The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field
|
||||
names listed in this parameter.
|
||||
The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any
|
||||
field names listed in this parameter.
|
||||
serializedName: searchFields
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2229,8 +2229,8 @@ operationGroups:
|
|||
default:
|
||||
name: $top
|
||||
description: >-
|
||||
The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation
|
||||
token that can be used to issue another Search request for the next page of results.
|
||||
The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a
|
||||
continuation token that can be used to issue another Search request for the next page of results.
|
||||
serializedName: $top
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2664,8 +2664,8 @@ operationGroups:
|
|||
default:
|
||||
name: UseFuzzyMatching
|
||||
description: >-
|
||||
A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides
|
||||
a better experience in some scenarios, it comes at a performance cost as fuzzy suggestions queries are slower and consume more resources.
|
||||
A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this
|
||||
provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestions queries are slower and consume more resources.
|
||||
serializedName: fuzzy
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2708,8 +2708,8 @@ operationGroups:
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even
|
||||
for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search
|
||||
availability even for services with only one replica. The default is 80.
|
||||
serializedName: minimumCoverage
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2724,9 +2724,9 @@ operationGroups:
|
|||
default:
|
||||
name: OrderBy
|
||||
description: >-
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to
|
||||
indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score.
|
||||
There can be at most 32 $orderby clauses.
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc
|
||||
to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document
|
||||
match score. There can be at most 32 $orderby clauses.
|
||||
serializedName: $orderby
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3263,8 +3263,8 @@ operationGroups:
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search
|
||||
availability even for services with only one replica. The default is 80.
|
||||
serializedName: minimumCoverage
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
|
|||
|
|
@ -187,8 +187,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: number
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even
|
||||
for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!NumberSchema> &ref_66
|
||||
type: integer
|
||||
|
|
@ -378,8 +378,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: SearchRequest-searchFields
|
||||
description: >-
|
||||
The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over
|
||||
any field names listed in this parameter.
|
||||
The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence
|
||||
over any field names listed in this parameter.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!StringSchema> &ref_22
|
||||
type: string
|
||||
|
|
@ -1252,8 +1252,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even
|
||||
for services with only one replica. The default is 100.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 100.
|
||||
serializedName: minimumCoverage
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -1263,8 +1263,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for
|
||||
services with only one replica. The default is 100.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even
|
||||
for services with only one replica. The default is 100.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!GroupProperty>
|
||||
schema: !<!ArraySchema> &ref_94
|
||||
|
|
@ -1287,9 +1287,9 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: OrderBy
|
||||
description: >-
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to
|
||||
indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match
|
||||
score. There can be at most 32 $orderby clauses.
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by
|
||||
asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by
|
||||
document match score. There can be at most 32 $orderby clauses.
|
||||
serializedName: $orderby
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -1299,9 +1299,9 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: OrderBy
|
||||
description: >-
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to
|
||||
indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score.
|
||||
There can be at most 32 $orderby clauses.
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc
|
||||
to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match
|
||||
score. There can be at most 32 $orderby clauses.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!GroupProperty>
|
||||
schema: *ref_16
|
||||
|
|
@ -1345,8 +1345,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: ScoringParameters
|
||||
description: >-
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the
|
||||
parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called
|
||||
'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
serializedName: scoringParameter
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -1357,8 +1357,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: ScoringParameters
|
||||
description: >-
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the
|
||||
parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation'
|
||||
the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!GroupProperty>
|
||||
schema: *ref_80
|
||||
|
|
@ -1402,8 +1402,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: searchFields
|
||||
description: >-
|
||||
The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field
|
||||
names listed in this parameter.
|
||||
The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any
|
||||
field names listed in this parameter.
|
||||
serializedName: searchFields
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -1479,8 +1479,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: $skip
|
||||
description: >-
|
||||
The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use $skip due to this limitation, consider using $orderby on a totally-ordered key and
|
||||
$filter with a range query instead.
|
||||
The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use $skip due to this limitation, consider using $orderby on a totally-ordered key
|
||||
and $filter with a range query instead.
|
||||
serializedName: $skip
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -1515,8 +1515,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: $top
|
||||
description: >-
|
||||
The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation
|
||||
token that can be used to issue another Search request for the next page of results.
|
||||
The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a
|
||||
continuation token that can be used to issue another Search request for the next page of results.
|
||||
protocol: !<!Protocols> {}
|
||||
usage:
|
||||
- input
|
||||
|
|
@ -1578,8 +1578,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: UseFuzzyMatching
|
||||
description: >-
|
||||
A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides
|
||||
a better experience in some scenarios, it comes at a performance cost as fuzzy suggestions queries are slower and consume more resources.
|
||||
A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this
|
||||
provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestions queries are slower and consume more resources.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!GroupProperty>
|
||||
schema: *ref_80
|
||||
|
|
@ -1634,8 +1634,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search
|
||||
availability even for services with only one replica. The default is 80.
|
||||
serializedName: minimumCoverage
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -1645,8 +1645,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even
|
||||
for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!GroupProperty>
|
||||
schema: !<!ArraySchema> &ref_101
|
||||
|
|
@ -1669,9 +1669,9 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: OrderBy
|
||||
description: >-
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to
|
||||
indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match
|
||||
score. There can be at most 32 $orderby clauses.
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by
|
||||
asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by
|
||||
document match score. There can be at most 32 $orderby clauses.
|
||||
serializedName: $orderby
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -1681,9 +1681,9 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: OrderBy
|
||||
description: >-
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to
|
||||
indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score.
|
||||
There can be at most 32 $orderby clauses.
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc
|
||||
to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match
|
||||
score. There can be at most 32 $orderby clauses.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!GroupProperty>
|
||||
schema: !<!ArraySchema> &ref_102
|
||||
|
|
@ -1905,8 +1905,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search
|
||||
availability even for services with only one replica. The default is 80.
|
||||
serializedName: minimumCoverage
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -1916,8 +1916,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search
|
||||
availability even for services with only one replica. The default is 80.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!GroupProperty>
|
||||
schema: !<!ArraySchema> &ref_106
|
||||
|
|
@ -2088,8 +2088,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even
|
||||
for services with only one replica. The default is 100.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 100.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_15
|
||||
|
|
@ -2098,9 +2098,9 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: OrderBy
|
||||
description: >-
|
||||
The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be
|
||||
followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending
|
||||
by document match score. There can be at most 32 $orderby clauses.
|
||||
The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression
|
||||
can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is
|
||||
descending by document match score. There can be at most 32 $orderby clauses.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_16
|
||||
|
|
@ -2121,16 +2121,16 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: SearchRequest-scoringParameters
|
||||
description: >-
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation'
|
||||
the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called
|
||||
'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
protocol: !<!Protocols> {}
|
||||
serializedName: scoringParameters
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: scoringParameters
|
||||
description: >-
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation'
|
||||
the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called
|
||||
'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_18
|
||||
|
|
@ -2155,8 +2155,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: searchFields
|
||||
description: >-
|
||||
The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence
|
||||
over any field names listed in this parameter.
|
||||
The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take
|
||||
precedence over any field names listed in this parameter.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_21
|
||||
|
|
@ -2181,8 +2181,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: skip
|
||||
description: >-
|
||||
The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use skip due to this limitation, consider using orderby on a totally-ordered key and
|
||||
filter with a range query instead.
|
||||
The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use skip due to this limitation, consider using orderby on a totally-ordered key
|
||||
and filter with a range query instead.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_24
|
||||
|
|
@ -2211,8 +2211,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: NextPageParameters
|
||||
description: >-
|
||||
Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get
|
||||
the next part of the search response.
|
||||
Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to
|
||||
get the next part of the search response.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: !<!ArraySchema> &ref_77
|
||||
|
|
@ -2280,8 +2280,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: NextLink
|
||||
description: >-
|
||||
Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search
|
||||
response. Make sure to use the same verb (GET or POST) as the request that produced this response.
|
||||
Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the
|
||||
search response. Make sure to use the same verb (GET or POST) as the request that produced this response.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -2417,8 +2417,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even
|
||||
for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_15
|
||||
|
|
@ -2428,8 +2428,8 @@ schemas: !<!Schemas>
|
|||
name: OrderBy
|
||||
description: >-
|
||||
The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be
|
||||
followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by
|
||||
document match score. There can be at most 32 $orderby clauses.
|
||||
followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending
|
||||
by document match score. There can be at most 32 $orderby clauses.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_41
|
||||
|
|
@ -2600,8 +2600,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: statusCode
|
||||
description: >-
|
||||
The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a
|
||||
version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy.
|
||||
The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for
|
||||
a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -2742,8 +2742,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: UseFuzzyMatching
|
||||
description: >-
|
||||
A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will autocomplete terms even if there's a substituted or missing character in the search text. While this
|
||||
provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.
|
||||
A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will autocomplete terms even if there's a substituted or missing character in the search text. While
|
||||
this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_61
|
||||
|
|
@ -2768,8 +2768,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search
|
||||
availability even for services with only one replica. The default is 80.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_64
|
||||
|
|
|
|||
|
|
@ -187,8 +187,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: number
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even
|
||||
for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!NumberSchema> &ref_83
|
||||
type: integer
|
||||
|
|
@ -378,8 +378,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: SearchRequest-searchFields
|
||||
description: >-
|
||||
The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over
|
||||
any field names listed in this parameter.
|
||||
The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence
|
||||
over any field names listed in this parameter.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!StringSchema> &ref_47
|
||||
type: string
|
||||
|
|
@ -985,8 +985,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even
|
||||
for services with only one replica. The default is 100.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 100.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_40
|
||||
|
|
@ -995,9 +995,9 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: OrderBy
|
||||
description: >-
|
||||
The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be
|
||||
followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending
|
||||
by document match score. There can be at most 32 $orderby clauses.
|
||||
The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression
|
||||
can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is
|
||||
descending by document match score. There can be at most 32 $orderby clauses.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_41
|
||||
|
|
@ -1018,16 +1018,16 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: SearchRequest-scoringParameters
|
||||
description: >-
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation'
|
||||
the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called
|
||||
'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
protocol: !<!Protocols> {}
|
||||
serializedName: scoringParameters
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: scoringParameters
|
||||
description: >-
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation'
|
||||
the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called
|
||||
'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_43
|
||||
|
|
@ -1052,8 +1052,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: searchFields
|
||||
description: >-
|
||||
The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence
|
||||
over any field names listed in this parameter.
|
||||
The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take
|
||||
precedence over any field names listed in this parameter.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_46
|
||||
|
|
@ -1078,8 +1078,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: skip
|
||||
description: >-
|
||||
The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use skip due to this limitation, consider using orderby on a totally-ordered key and
|
||||
filter with a range query instead.
|
||||
The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use skip due to this limitation, consider using orderby on a totally-ordered key
|
||||
and filter with a range query instead.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_49
|
||||
|
|
@ -1108,8 +1108,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: NextPageParameters
|
||||
description: >-
|
||||
Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get
|
||||
the next part of the search response.
|
||||
Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to
|
||||
get the next part of the search response.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: !<!ArraySchema> &ref_50
|
||||
|
|
@ -1177,8 +1177,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: NextLink
|
||||
description: >-
|
||||
Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search
|
||||
response. Make sure to use the same verb (GET or POST) as the request that produced this response.
|
||||
Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the
|
||||
search response. Make sure to use the same verb (GET or POST) as the request that produced this response.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -1314,8 +1314,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even
|
||||
for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_40
|
||||
|
|
@ -1325,8 +1325,8 @@ schemas: !<!Schemas>
|
|||
name: OrderBy
|
||||
description: >-
|
||||
The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be
|
||||
followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by
|
||||
document match score. There can be at most 32 $orderby clauses.
|
||||
followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending
|
||||
by document match score. There can be at most 32 $orderby clauses.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_63
|
||||
|
|
@ -1497,8 +1497,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: statusCode
|
||||
description: >-
|
||||
The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a
|
||||
version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy.
|
||||
The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for
|
||||
a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -1639,8 +1639,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: UseFuzzyMatching
|
||||
description: >-
|
||||
A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will autocomplete terms even if there's a substituted or missing character in the search text. While this
|
||||
provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.
|
||||
A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will autocomplete terms even if there's a substituted or missing character in the search text. While
|
||||
this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_78
|
||||
|
|
@ -1665,8 +1665,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search
|
||||
availability even for services with only one replica. The default is 80.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_81
|
||||
|
|
@ -2091,8 +2091,8 @@ operationGroups:
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for
|
||||
services with only one replica. The default is 100.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 100.
|
||||
serializedName: minimumCoverage
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2107,9 +2107,9 @@ operationGroups:
|
|||
default:
|
||||
name: OrderBy
|
||||
description: >-
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to
|
||||
indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score.
|
||||
There can be at most 32 $orderby clauses.
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc
|
||||
to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document
|
||||
match score. There can be at most 32 $orderby clauses.
|
||||
serializedName: $orderby
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2138,8 +2138,8 @@ operationGroups:
|
|||
default:
|
||||
name: ScoringParameters
|
||||
description: >-
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the
|
||||
parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation'
|
||||
the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
serializedName: scoringParameter
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2169,8 +2169,8 @@ operationGroups:
|
|||
default:
|
||||
name: searchFields
|
||||
description: >-
|
||||
The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field
|
||||
names listed in this parameter.
|
||||
The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any
|
||||
field names listed in this parameter.
|
||||
serializedName: searchFields
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2229,8 +2229,8 @@ operationGroups:
|
|||
default:
|
||||
name: $top
|
||||
description: >-
|
||||
The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation
|
||||
token that can be used to issue another Search request for the next page of results.
|
||||
The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a
|
||||
continuation token that can be used to issue another Search request for the next page of results.
|
||||
serializedName: $top
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2664,8 +2664,8 @@ operationGroups:
|
|||
default:
|
||||
name: UseFuzzyMatching
|
||||
description: >-
|
||||
A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides
|
||||
a better experience in some scenarios, it comes at a performance cost as fuzzy suggestions queries are slower and consume more resources.
|
||||
A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this
|
||||
provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestions queries are slower and consume more resources.
|
||||
serializedName: fuzzy
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2708,8 +2708,8 @@ operationGroups:
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even
|
||||
for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search
|
||||
availability even for services with only one replica. The default is 80.
|
||||
serializedName: minimumCoverage
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2724,9 +2724,9 @@ operationGroups:
|
|||
default:
|
||||
name: OrderBy
|
||||
description: >-
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to
|
||||
indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score.
|
||||
There can be at most 32 $orderby clauses.
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc
|
||||
to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document
|
||||
match score. There can be at most 32 $orderby clauses.
|
||||
serializedName: $orderby
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3250,8 +3250,8 @@ operationGroups:
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search
|
||||
availability even for services with only one replica. The default is 80.
|
||||
serializedName: minimumCoverage
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
|
|||
|
|
@ -187,8 +187,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: Number
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even
|
||||
for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!NumberSchema> &ref_96
|
||||
type: integer
|
||||
|
|
@ -378,8 +378,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: SearchRequestSearchFields
|
||||
description: >-
|
||||
The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over
|
||||
any field names listed in this parameter.
|
||||
The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence
|
||||
over any field names listed in this parameter.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!StringSchema> &ref_53
|
||||
type: string
|
||||
|
|
@ -1252,8 +1252,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: _minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even
|
||||
for services with only one replica. The default is 100.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 100.
|
||||
serializedName: minimumCoverage
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -1263,8 +1263,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for
|
||||
services with only one replica. The default is 100.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even
|
||||
for services with only one replica. The default is 100.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!GroupProperty>
|
||||
schema: !<!ArraySchema> &ref_17
|
||||
|
|
@ -1287,9 +1287,9 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: _orderBy
|
||||
description: >-
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to
|
||||
indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match
|
||||
score. There can be at most 32 $orderby clauses.
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by
|
||||
asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by
|
||||
document match score. There can be at most 32 $orderby clauses.
|
||||
serializedName: $orderby
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -1299,9 +1299,9 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: orderBy
|
||||
description: >-
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to
|
||||
indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score.
|
||||
There can be at most 32 $orderby clauses.
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc
|
||||
to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match
|
||||
score. There can be at most 32 $orderby clauses.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!GroupProperty>
|
||||
schema: *ref_18
|
||||
|
|
@ -1345,8 +1345,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: _scoringParameters
|
||||
description: >-
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the
|
||||
parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called
|
||||
'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
serializedName: scoringParameter
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -1357,8 +1357,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: scoringParameters
|
||||
description: >-
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the
|
||||
parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation'
|
||||
the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!GroupProperty>
|
||||
schema: *ref_12
|
||||
|
|
@ -1402,8 +1402,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: _searchFields
|
||||
description: >-
|
||||
The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field
|
||||
names listed in this parameter.
|
||||
The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any
|
||||
field names listed in this parameter.
|
||||
serializedName: searchFields
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -1479,8 +1479,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: _skip
|
||||
description: >-
|
||||
The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use $skip due to this limitation, consider using $orderby on a totally-ordered key and
|
||||
$filter with a range query instead.
|
||||
The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use $skip due to this limitation, consider using $orderby on a totally-ordered key
|
||||
and $filter with a range query instead.
|
||||
serializedName: $skip
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -1515,8 +1515,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: top
|
||||
description: >-
|
||||
The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation
|
||||
token that can be used to issue another Search request for the next page of results.
|
||||
The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a
|
||||
continuation token that can be used to issue another Search request for the next page of results.
|
||||
protocol: !<!Protocols> {}
|
||||
usage:
|
||||
- input
|
||||
|
|
@ -1578,8 +1578,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: useFuzzyMatching
|
||||
description: >-
|
||||
A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides
|
||||
a better experience in some scenarios, it comes at a performance cost as fuzzy suggestions queries are slower and consume more resources.
|
||||
A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this
|
||||
provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestions queries are slower and consume more resources.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!GroupProperty>
|
||||
schema: *ref_12
|
||||
|
|
@ -1634,8 +1634,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: _minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search
|
||||
availability even for services with only one replica. The default is 80.
|
||||
serializedName: minimumCoverage
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -1645,8 +1645,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even
|
||||
for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!GroupProperty>
|
||||
schema: !<!ArraySchema> &ref_30
|
||||
|
|
@ -1669,9 +1669,9 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: _orderBy
|
||||
description: >-
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to
|
||||
indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match
|
||||
score. There can be at most 32 $orderby clauses.
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by
|
||||
asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by
|
||||
document match score. There can be at most 32 $orderby clauses.
|
||||
serializedName: $orderby
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -1681,9 +1681,9 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: orderBy
|
||||
description: >-
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to
|
||||
indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score.
|
||||
There can be at most 32 $orderby clauses.
|
||||
The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc
|
||||
to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match
|
||||
score. There can be at most 32 $orderby clauses.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!GroupProperty>
|
||||
schema: !<!ArraySchema> &ref_31
|
||||
|
|
@ -1905,8 +1905,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: _minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search
|
||||
availability even for services with only one replica. The default is 80.
|
||||
serializedName: minimumCoverage
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -1916,8 +1916,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search
|
||||
availability even for services with only one replica. The default is 80.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!GroupProperty>
|
||||
schema: !<!ArraySchema> &ref_37
|
||||
|
|
@ -2088,8 +2088,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even
|
||||
for services with only one replica. The default is 100.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 100.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_48
|
||||
|
|
@ -2098,9 +2098,9 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: orderBy
|
||||
description: >-
|
||||
The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be
|
||||
followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending
|
||||
by document match score. There can be at most 32 $orderby clauses.
|
||||
The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression
|
||||
can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is
|
||||
descending by document match score. There can be at most 32 $orderby clauses.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_18
|
||||
|
|
@ -2121,16 +2121,16 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: SearchRequestScoringParameters
|
||||
description: >-
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation'
|
||||
the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called
|
||||
'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
protocol: !<!Protocols> {}
|
||||
serializedName: scoringParameters
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: scoringParameters
|
||||
description: >-
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation'
|
||||
the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called
|
||||
'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes).
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_50
|
||||
|
|
@ -2155,8 +2155,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: searchFields
|
||||
description: >-
|
||||
The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence
|
||||
over any field names listed in this parameter.
|
||||
The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take
|
||||
precedence over any field names listed in this parameter.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_23
|
||||
|
|
@ -2181,8 +2181,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: skip
|
||||
description: >-
|
||||
The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use skip due to this limitation, consider using orderby on a totally-ordered key and
|
||||
filter with a range query instead.
|
||||
The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use skip due to this limitation, consider using orderby on a totally-ordered key
|
||||
and filter with a range query instead.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_55
|
||||
|
|
@ -2211,8 +2211,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: nextPageParameters
|
||||
description: >-
|
||||
Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get
|
||||
the next part of the search response.
|
||||
Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to
|
||||
get the next part of the search response.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: !<!ArraySchema> &ref_101
|
||||
|
|
@ -2280,8 +2280,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: nextLink
|
||||
description: >-
|
||||
Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search
|
||||
response. Make sure to use the same verb (GET or POST) as the request that produced this response.
|
||||
Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the
|
||||
search response. Make sure to use the same verb (GET or POST) as the request that produced this response.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -2417,8 +2417,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even
|
||||
for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_48
|
||||
|
|
@ -2428,8 +2428,8 @@ schemas: !<!Schemas>
|
|||
name: orderBy
|
||||
description: >-
|
||||
The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be
|
||||
followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by
|
||||
document match score. There can be at most 32 $orderby clauses.
|
||||
followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending
|
||||
by document match score. There can be at most 32 $orderby clauses.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_72
|
||||
|
|
@ -2600,8 +2600,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: statusCode
|
||||
description: >-
|
||||
The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a
|
||||
version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy.
|
||||
The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for
|
||||
a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -2742,8 +2742,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: useFuzzyMatching
|
||||
description: >-
|
||||
A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will autocomplete terms even if there's a substituted or missing character in the search text. While this
|
||||
provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.
|
||||
A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will autocomplete terms even if there's a substituted or missing character in the search text. While
|
||||
this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_91
|
||||
|
|
@ -2768,8 +2768,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: minimumCoverage
|
||||
description: >-
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability
|
||||
even for services with only one replica. The default is 80.
|
||||
A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search
|
||||
availability even for services with only one replica. The default is 80.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_94
|
||||
|
|
|
|||
|
|
@ -2366,8 +2366,8 @@ operationGroups:
|
|||
default:
|
||||
name: continuation
|
||||
description: >-
|
||||
The number of filesystems returned with each invocation is limited. If the number of filesystems to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation
|
||||
token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems.
|
||||
The number of filesystems returned with each invocation is limited. If the number of filesystems to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a
|
||||
continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems.
|
||||
serializedName: continuation
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2516,8 +2516,8 @@ operationGroups:
|
|||
default:
|
||||
name: filesystem
|
||||
description: >-
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The
|
||||
value must have between 3 and 63 characters.
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase.
|
||||
The value must have between 3 and 63 characters.
|
||||
serializedName: filesystem
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2577,8 +2577,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-properties
|
||||
description: >-
|
||||
User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only contain
|
||||
ASCII characters in the ISO-8859-1 character set.
|
||||
User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only
|
||||
contain ASCII characters in the ISO-8859-1 character set.
|
||||
serializedName: x-ms-properties
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2671,8 +2671,8 @@ operationGroups:
|
|||
default:
|
||||
name: filesystem
|
||||
description: >-
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The
|
||||
value must have between 3 and 63 characters.
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase.
|
||||
The value must have between 3 and 63 characters.
|
||||
serializedName: filesystem
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2732,9 +2732,9 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-properties
|
||||
description: >-
|
||||
Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only
|
||||
contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing
|
||||
properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.
|
||||
Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may
|
||||
only contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and
|
||||
existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.
|
||||
serializedName: x-ms-properties
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2850,8 +2850,8 @@ operationGroups:
|
|||
default:
|
||||
name: filesystem
|
||||
description: >-
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The
|
||||
value must have between 3 and 63 characters.
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase.
|
||||
The value must have between 3 and 63 characters.
|
||||
serializedName: filesystem
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2994,8 +2994,8 @@ operationGroups:
|
|||
default:
|
||||
name: filesystem
|
||||
description: >-
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The
|
||||
value must have between 3 and 63 characters.
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase.
|
||||
The value must have between 3 and 63 characters.
|
||||
serializedName: filesystem
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3135,8 +3135,8 @@ operationGroups:
|
|||
description: >-
|
||||
Marks the filesystem for deletion. When a filesystem is deleted, a filesystem with the same identifier cannot be created for at least 30 seconds. While the filesystem is being deleted, attempts to create a filesystem with the
|
||||
same identifier will fail with status code 409 (Conflict), with the service returning additional error information indicating that the filesystem is being deleted. All other operations, including operations on any files or
|
||||
directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for
|
||||
Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers
|
||||
for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Delete Filesystem
|
||||
protocol: !<!Protocols> {}
|
||||
language: !<!Languages>
|
||||
|
|
@ -3162,8 +3162,8 @@ operationGroups:
|
|||
default:
|
||||
name: filesystem
|
||||
description: >-
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The
|
||||
value must have between 3 and 63 characters.
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase.
|
||||
The value must have between 3 and 63 characters.
|
||||
serializedName: filesystem
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3246,8 +3246,8 @@ operationGroups:
|
|||
default:
|
||||
name: continuation
|
||||
description: >-
|
||||
The number of paths returned with each invocation is limited. If the number of paths to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is
|
||||
returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.
|
||||
The number of paths returned with each invocation is limited. If the number of paths to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token
|
||||
is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.
|
||||
serializedName: continuation
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3270,9 +3270,9 @@ operationGroups:
|
|||
default:
|
||||
name: upn
|
||||
description: >-
|
||||
Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory Object
|
||||
IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have
|
||||
unique friendly names.
|
||||
Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory
|
||||
Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do
|
||||
not have unique friendly names.
|
||||
serializedName: upn
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3450,8 +3450,8 @@ operationGroups:
|
|||
default:
|
||||
name: continuation
|
||||
description: >-
|
||||
Optional. When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header.
|
||||
When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.
|
||||
Optional. When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response
|
||||
header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.
|
||||
serializedName: continuation
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3573,8 +3573,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-rename-source
|
||||
description: >-
|
||||
An optional file or directory to be renamed. The value must have the following format: "/{filesystem}/{path}". If "x-ms-properties" is specified, the properties will overwrite the existing properties; otherwise, the existing
|
||||
properties will be preserved. This value must be a URL percent-encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.
|
||||
An optional file or directory to be renamed. The value must have the following format: "/{filesystem}/{path}". If "x-ms-properties" is specified, the properties will overwrite the existing properties; otherwise, the
|
||||
existing properties will be preserved. This value must be a URL percent-encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.
|
||||
serializedName: x-ms-rename-source
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3608,8 +3608,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-properties
|
||||
description: >-
|
||||
Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string
|
||||
may only contain ASCII characters in the ISO-8859-1 character set.
|
||||
Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the
|
||||
string may only contain ASCII characters in the ISO-8859-1 character set.
|
||||
serializedName: x-ms-properties
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3621,8 +3621,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-permissions
|
||||
description: >-
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission.
|
||||
The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute
|
||||
permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.
|
||||
serializedName: x-ms-permissions
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3634,9 +3634,9 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-umask
|
||||
description: >-
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the permissions of the file or directory to
|
||||
be created. The resulting permission is given by p & ^u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission is 0777 for a
|
||||
directory and 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766).
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the permissions of the file or
|
||||
directory to be created. The resulting permission is given by p & ^u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission
|
||||
is 0777 for a directory and 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766).
|
||||
serializedName: x-ms-umask
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3909,9 +3909,9 @@ operationGroups:
|
|||
default:
|
||||
name: action
|
||||
description: >-
|
||||
The action must be "append" to upload data to be appended to a file, "flush" to flush previously uploaded data to a file, "setProperties" to set the properties of a file or directory, or "setAccessControl" to set the owner,
|
||||
group, permissions, or access control list for a file or directory. Note that Hierarchical Namespace must be enabled for the account in order to use access control. Also note that the Access Control List (ACL) includes
|
||||
permissions for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers are mutually exclusive.
|
||||
The action must be "append" to upload data to be appended to a file, "flush" to flush previously uploaded data to a file, "setProperties" to set the properties of a file or directory, or "setAccessControl" to set the
|
||||
owner, group, permissions, or access control list for a file or directory. Note that Hierarchical Namespace must be enabled for the account in order to use access control. Also note that the Access Control List (ACL)
|
||||
includes permissions for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers are mutually exclusive.
|
||||
serializedName: action
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3923,9 +3923,9 @@ operationGroups:
|
|||
default:
|
||||
name: position
|
||||
description: >-
|
||||
This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded data to
|
||||
the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the position parameter
|
||||
must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request.
|
||||
This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded
|
||||
data to the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the
|
||||
position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request.
|
||||
serializedName: position
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3937,8 +3937,8 @@ operationGroups:
|
|||
default:
|
||||
name: retainUncommittedData
|
||||
description: >-
|
||||
Valid only for flush operations. If "true", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets less
|
||||
than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation.
|
||||
Valid only for flush operations. If "true", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets
|
||||
less than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation.
|
||||
serializedName: retainUncommittedData
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3950,10 +3950,10 @@ operationGroups:
|
|||
default:
|
||||
name: close
|
||||
description: >-
|
||||
Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final change to
|
||||
distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is "flush" and change notifications are enabled. If the
|
||||
value of close is "true" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been closed). If "false" a
|
||||
change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed."
|
||||
Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final
|
||||
change to distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is "flush" and change notifications are
|
||||
enabled. If the value of close is "true" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been
|
||||
closed). If "false" a change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed."
|
||||
serializedName: close
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3976,9 +3976,9 @@ operationGroups:
|
|||
default:
|
||||
name: Content-MD5
|
||||
description: >-
|
||||
Optional. An MD5 hash of the request content. This header is valid on "Append" and "Flush" operations. This hash is used to verify the integrity of the request content during transport. When this header is specified, the storage
|
||||
service compares the hash of the content that has arrived with this header value. If the two hashes do not match, the operation will fail with error code 400 (Bad Request). Note that this MD5 hash is not stored with the file.
|
||||
This header is associated with the request content, and not with the stored content of the file itself.
|
||||
Optional. An MD5 hash of the request content. This header is valid on "Append" and "Flush" operations. This hash is used to verify the integrity of the request content during transport. When this header is specified, the
|
||||
storage service compares the hash of the content that has arrived with this header value. If the two hashes do not match, the operation will fail with error code 400 (Bad Request). Note that this MD5 hash is not stored
|
||||
with the file. This header is associated with the request content, and not with the stored content of the file itself.
|
||||
serializedName: Content-MD5
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4056,8 +4056,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-content-md5
|
||||
description: >-
|
||||
Optional and only valid for "Flush & Set Properties" operations. The service stores this value and includes it in the "Content-Md5" response header for "Read & Get Properties" operations. If this property is not specified on
|
||||
the request, then the property will be cleared for the file. Subsequent calls to "Read & Get Properties" will not return this property unless it is explicitly set on that file again.
|
||||
Optional and only valid for "Flush & Set Properties" operations. The service stores this value and includes it in the "Content-Md5" response header for "Read & Get Properties" operations. If this property is not specified
|
||||
on the request, then the property will be cleared for the file. Subsequent calls to "Read & Get Properties" will not return this property unless it is explicitly set on that file again.
|
||||
serializedName: x-ms-content-md5
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4069,9 +4069,10 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-properties
|
||||
description: >-
|
||||
Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string
|
||||
may only contain ASCII characters in the ISO-8859-1 character set. Valid only for the setProperties operation. If the file or directory exists, any properties not included in the list will be removed. All properties are removed
|
||||
if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.
|
||||
Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the
|
||||
string may only contain ASCII characters in the ISO-8859-1 character set. Valid only for the setProperties operation. If the file or directory exists, any properties not included in the list will be removed. All
|
||||
properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all
|
||||
properties.
|
||||
serializedName: x-ms-properties
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4105,8 +4106,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-permissions
|
||||
description: >-
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission.
|
||||
The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. Invalid in conjunction with x-ms-acl.
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute
|
||||
permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. Invalid in conjunction with x-ms-acl.
|
||||
serializedName: x-ms-permissions
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4118,14 +4119,14 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-acl
|
||||
description: >-
|
||||
Optional and valid only for the setAccessControl operation. Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries that fully replaces the existing access control
|
||||
list (ACL). Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]". The scope must be "default" to indicate the ACE belongs to
|
||||
the default ACL for a directory; otherwise scope is implicit and the ACE belongs to the access ACL. There are four ACE types: "user" grants rights to the owner or a named user, "group" grants rights to the owning group or a
|
||||
named group, "mask" restricts rights granted to named users and the members of groups, and "other" grants rights to all users not found in any of the other entries. The user or group identifier is omitted for entries of type
|
||||
"mask" and "other". The user or group identifier is also omitted for the owner and owning group. The permission field is a 3-character sequence where the first character is 'r' to grant read access, the second character is 'w'
|
||||
to grant write access, and the third character is 'x' to grant execute permission. If access is not granted, the '-' character is used to denote that the permission is denied. For example, the following ACL grants read, write,
|
||||
and execute rights to the file owner and john.doe@contoso, the read right to the owning group, and nothing to everyone else: "user::rwx,user:john.doe@contoso:rwx,group::r--,other::---,mask=rwx". Invalid in conjunction with
|
||||
x-ms-permissions.
|
||||
Optional and valid only for the setAccessControl operation. Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries that fully replaces the existing access
|
||||
control list (ACL). Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]". The scope must be "default" to indicate the
|
||||
ACE belongs to the default ACL for a directory; otherwise scope is implicit and the ACE belongs to the access ACL. There are four ACE types: "user" grants rights to the owner or a named user, "group" grants rights to the
|
||||
owning group or a named group, "mask" restricts rights granted to named users and the members of groups, and "other" grants rights to all users not found in any of the other entries. The user or group identifier is omitted
|
||||
for entries of type "mask" and "other". The user or group identifier is also omitted for the owner and owning group. The permission field is a 3-character sequence where the first character is 'r' to grant read access,
|
||||
the second character is 'w' to grant write access, and the third character is 'x' to grant execute permission. If access is not granted, the '-' character is used to denote that the permission is denied. For example, the
|
||||
following ACL grants read, write, and execute rights to the file owner and john.doe@contoso, the read right to the owning group, and nothing to everyone else:
|
||||
"user::rwx,user:john.doe@contoso:rwx,group::r--,other::---,mask=rwx". Invalid in conjunction with x-ms-permissions.
|
||||
serializedName: x-ms-acl
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4136,7 +4137,9 @@ operationGroups:
|
|||
language: !<!Languages>
|
||||
default:
|
||||
name: If-Match
|
||||
description: 'Optional for Flush Data and Set Properties, but invalid for Append Data. An ETag value. Specify this header to perform the operation only if the resource''s ETag matches the value specified. The ETag must be specified in quotes.'
|
||||
description: >-
|
||||
Optional for Flush Data and Set Properties, but invalid for Append Data. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in
|
||||
quotes.
|
||||
serializedName: If-Match
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4446,10 +4449,10 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-lease-action
|
||||
description: >-
|
||||
There are five lease actions: "acquire", "break", "change", "renew", and "release". Use "acquire" and specify the "x-ms-proposed-lease-id" and "x-ms-lease-duration" to acquire a new lease. Use "break" to break an existing lease.
|
||||
When a lease is broken, the lease break period is allowed to elapse, during which time no lease operation except break and release can be performed on the file. When a lease is successfully broken, the response indicates the
|
||||
interval in seconds until a new lease can be acquired. Use "change" and specify the current lease ID in "x-ms-lease-id" and the new lease ID in "x-ms-proposed-lease-id" to change the lease ID of an active lease. Use "renew" and
|
||||
specify the "x-ms-lease-id" to renew an existing lease. Use "release" and specify the "x-ms-lease-id" to release a lease.
|
||||
There are five lease actions: "acquire", "break", "change", "renew", and "release". Use "acquire" and specify the "x-ms-proposed-lease-id" and "x-ms-lease-duration" to acquire a new lease. Use "break" to break an existing
|
||||
lease. When a lease is broken, the lease break period is allowed to elapse, during which time no lease operation except break and release can be performed on the file. When a lease is successfully broken, the response
|
||||
indicates the interval in seconds until a new lease can be acquired. Use "change" and specify the current lease ID in "x-ms-lease-id" and the new lease ID in "x-ms-proposed-lease-id" to change the lease ID of an active
|
||||
lease. Use "renew" and specify the "x-ms-lease-id" to renew an existing lease. Use "release" and specify the "x-ms-lease-id" to release a lease.
|
||||
serializedName: x-ms-lease-action
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4764,8 +4767,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-lease-id
|
||||
description: >-
|
||||
Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of the
|
||||
path.
|
||||
Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of
|
||||
the path.
|
||||
serializedName: x-ms-lease-id
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4777,8 +4780,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-range-get-content-md5
|
||||
description: >-
|
||||
Optional. When this header is set to "true" and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4MB in size. If this header is specified
|
||||
without the Range header, the service returns status code 400 (Bad Request). If this header is set to true when the range exceeds 4 MB in size, the service returns status code 400 (Bad Request).
|
||||
Optional. When this header is set to "true" and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4MB in size. If this header is
|
||||
specified without the Range header, the service returns status code 400 (Bad Request). If this header is set to true when the range exceeds 4 MB in size, the service returns status code 400 (Bad Request).
|
||||
serializedName: x-ms-range-get-content-md5
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -5247,8 +5250,8 @@ operationGroups:
|
|||
default:
|
||||
name: action
|
||||
description: >-
|
||||
Optional. If the value is "getStatus" only the system defined properties for the path are returned. If the value is "getAccessControl" the access control list is returned in the response headers (Hierarchical Namespace must be
|
||||
enabled for the account), otherwise the properties are returned.
|
||||
Optional. If the value is "getStatus" only the system defined properties for the path are returned. If the value is "getAccessControl" the access control list is returned in the response headers (Hierarchical Namespace
|
||||
must be enabled for the account), otherwise the properties are returned.
|
||||
serializedName: action
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -5261,8 +5264,8 @@ operationGroups:
|
|||
name: upn
|
||||
description: >-
|
||||
Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active
|
||||
Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they
|
||||
do not have unique friendly names.
|
||||
Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because
|
||||
they do not have unique friendly names.
|
||||
serializedName: upn
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -5285,8 +5288,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-lease-id
|
||||
description: >-
|
||||
Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of the
|
||||
path.
|
||||
Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of
|
||||
the path.
|
||||
serializedName: x-ms-lease-id
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -5555,8 +5558,8 @@ operationGroups:
|
|||
default:
|
||||
name: continuation
|
||||
description: >-
|
||||
Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header.
|
||||
When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.
|
||||
Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response
|
||||
header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.
|
||||
serializedName: continuation
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
|
|||
|
|
@ -2366,8 +2366,8 @@ operationGroups:
|
|||
default:
|
||||
name: continuation
|
||||
description: >-
|
||||
The number of filesystems returned with each invocation is limited. If the number of filesystems to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation
|
||||
token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems.
|
||||
The number of filesystems returned with each invocation is limited. If the number of filesystems to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a
|
||||
continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems.
|
||||
serializedName: continuation
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2516,8 +2516,8 @@ operationGroups:
|
|||
default:
|
||||
name: filesystem
|
||||
description: >-
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The
|
||||
value must have between 3 and 63 characters.
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase.
|
||||
The value must have between 3 and 63 characters.
|
||||
serializedName: filesystem
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2577,8 +2577,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-properties
|
||||
description: >-
|
||||
User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only contain
|
||||
ASCII characters in the ISO-8859-1 character set.
|
||||
User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only
|
||||
contain ASCII characters in the ISO-8859-1 character set.
|
||||
serializedName: x-ms-properties
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2671,8 +2671,8 @@ operationGroups:
|
|||
default:
|
||||
name: filesystem
|
||||
description: >-
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The
|
||||
value must have between 3 and 63 characters.
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase.
|
||||
The value must have between 3 and 63 characters.
|
||||
serializedName: filesystem
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2732,9 +2732,9 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-properties
|
||||
description: >-
|
||||
Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only
|
||||
contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing
|
||||
properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.
|
||||
Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may
|
||||
only contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and
|
||||
existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.
|
||||
serializedName: x-ms-properties
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2850,8 +2850,8 @@ operationGroups:
|
|||
default:
|
||||
name: filesystem
|
||||
description: >-
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The
|
||||
value must have between 3 and 63 characters.
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase.
|
||||
The value must have between 3 and 63 characters.
|
||||
serializedName: filesystem
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2994,8 +2994,8 @@ operationGroups:
|
|||
default:
|
||||
name: filesystem
|
||||
description: >-
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The
|
||||
value must have between 3 and 63 characters.
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase.
|
||||
The value must have between 3 and 63 characters.
|
||||
serializedName: filesystem
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3135,8 +3135,8 @@ operationGroups:
|
|||
description: >-
|
||||
Marks the filesystem for deletion. When a filesystem is deleted, a filesystem with the same identifier cannot be created for at least 30 seconds. While the filesystem is being deleted, attempts to create a filesystem with the
|
||||
same identifier will fail with status code 409 (Conflict), with the service returning additional error information indicating that the filesystem is being deleted. All other operations, including operations on any files or
|
||||
directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for
|
||||
Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers
|
||||
for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Delete Filesystem
|
||||
protocol: !<!Protocols> {}
|
||||
language: !<!Languages>
|
||||
|
|
@ -3162,8 +3162,8 @@ operationGroups:
|
|||
default:
|
||||
name: filesystem
|
||||
description: >-
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The
|
||||
value must have between 3 and 63 characters.
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase.
|
||||
The value must have between 3 and 63 characters.
|
||||
serializedName: filesystem
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3246,8 +3246,8 @@ operationGroups:
|
|||
default:
|
||||
name: continuation
|
||||
description: >-
|
||||
The number of paths returned with each invocation is limited. If the number of paths to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is
|
||||
returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.
|
||||
The number of paths returned with each invocation is limited. If the number of paths to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token
|
||||
is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.
|
||||
serializedName: continuation
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3270,9 +3270,9 @@ operationGroups:
|
|||
default:
|
||||
name: upn
|
||||
description: >-
|
||||
Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory Object
|
||||
IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have
|
||||
unique friendly names.
|
||||
Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory
|
||||
Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do
|
||||
not have unique friendly names.
|
||||
serializedName: upn
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3450,8 +3450,8 @@ operationGroups:
|
|||
default:
|
||||
name: continuation
|
||||
description: >-
|
||||
Optional. When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header.
|
||||
When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.
|
||||
Optional. When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response
|
||||
header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.
|
||||
serializedName: continuation
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3573,8 +3573,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-rename-source
|
||||
description: >-
|
||||
An optional file or directory to be renamed. The value must have the following format: "/{filesystem}/{path}". If "x-ms-properties" is specified, the properties will overwrite the existing properties; otherwise, the existing
|
||||
properties will be preserved. This value must be a URL percent-encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.
|
||||
An optional file or directory to be renamed. The value must have the following format: "/{filesystem}/{path}". If "x-ms-properties" is specified, the properties will overwrite the existing properties; otherwise, the
|
||||
existing properties will be preserved. This value must be a URL percent-encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.
|
||||
serializedName: x-ms-rename-source
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3608,8 +3608,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-properties
|
||||
description: >-
|
||||
Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string
|
||||
may only contain ASCII characters in the ISO-8859-1 character set.
|
||||
Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the
|
||||
string may only contain ASCII characters in the ISO-8859-1 character set.
|
||||
serializedName: x-ms-properties
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3621,8 +3621,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-permissions
|
||||
description: >-
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission.
|
||||
The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute
|
||||
permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.
|
||||
serializedName: x-ms-permissions
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3634,9 +3634,9 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-umask
|
||||
description: >-
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the permissions of the file or directory to
|
||||
be created. The resulting permission is given by p & ^u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission is 0777 for a
|
||||
directory and 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766).
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the permissions of the file or
|
||||
directory to be created. The resulting permission is given by p & ^u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission
|
||||
is 0777 for a directory and 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766).
|
||||
serializedName: x-ms-umask
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3909,9 +3909,9 @@ operationGroups:
|
|||
default:
|
||||
name: action
|
||||
description: >-
|
||||
The action must be "append" to upload data to be appended to a file, "flush" to flush previously uploaded data to a file, "setProperties" to set the properties of a file or directory, or "setAccessControl" to set the owner,
|
||||
group, permissions, or access control list for a file or directory. Note that Hierarchical Namespace must be enabled for the account in order to use access control. Also note that the Access Control List (ACL) includes
|
||||
permissions for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers are mutually exclusive.
|
||||
The action must be "append" to upload data to be appended to a file, "flush" to flush previously uploaded data to a file, "setProperties" to set the properties of a file or directory, or "setAccessControl" to set the
|
||||
owner, group, permissions, or access control list for a file or directory. Note that Hierarchical Namespace must be enabled for the account in order to use access control. Also note that the Access Control List (ACL)
|
||||
includes permissions for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers are mutually exclusive.
|
||||
serializedName: action
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3923,9 +3923,9 @@ operationGroups:
|
|||
default:
|
||||
name: position
|
||||
description: >-
|
||||
This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded data to
|
||||
the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the position parameter
|
||||
must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request.
|
||||
This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded
|
||||
data to the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the
|
||||
position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request.
|
||||
serializedName: position
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3937,8 +3937,8 @@ operationGroups:
|
|||
default:
|
||||
name: retainUncommittedData
|
||||
description: >-
|
||||
Valid only for flush operations. If "true", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets less
|
||||
than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation.
|
||||
Valid only for flush operations. If "true", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets
|
||||
less than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation.
|
||||
serializedName: retainUncommittedData
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3950,10 +3950,10 @@ operationGroups:
|
|||
default:
|
||||
name: close
|
||||
description: >-
|
||||
Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final change to
|
||||
distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is "flush" and change notifications are enabled. If the
|
||||
value of close is "true" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been closed). If "false" a
|
||||
change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed."
|
||||
Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final
|
||||
change to distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is "flush" and change notifications are
|
||||
enabled. If the value of close is "true" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been
|
||||
closed). If "false" a change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed."
|
||||
serializedName: close
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3976,9 +3976,9 @@ operationGroups:
|
|||
default:
|
||||
name: Content-MD5
|
||||
description: >-
|
||||
Optional. An MD5 hash of the request content. This header is valid on "Append" and "Flush" operations. This hash is used to verify the integrity of the request content during transport. When this header is specified, the storage
|
||||
service compares the hash of the content that has arrived with this header value. If the two hashes do not match, the operation will fail with error code 400 (Bad Request). Note that this MD5 hash is not stored with the file.
|
||||
This header is associated with the request content, and not with the stored content of the file itself.
|
||||
Optional. An MD5 hash of the request content. This header is valid on "Append" and "Flush" operations. This hash is used to verify the integrity of the request content during transport. When this header is specified, the
|
||||
storage service compares the hash of the content that has arrived with this header value. If the two hashes do not match, the operation will fail with error code 400 (Bad Request). Note that this MD5 hash is not stored
|
||||
with the file. This header is associated with the request content, and not with the stored content of the file itself.
|
||||
serializedName: Content-MD5
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4056,8 +4056,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-content-md5
|
||||
description: >-
|
||||
Optional and only valid for "Flush & Set Properties" operations. The service stores this value and includes it in the "Content-Md5" response header for "Read & Get Properties" operations. If this property is not specified on
|
||||
the request, then the property will be cleared for the file. Subsequent calls to "Read & Get Properties" will not return this property unless it is explicitly set on that file again.
|
||||
Optional and only valid for "Flush & Set Properties" operations. The service stores this value and includes it in the "Content-Md5" response header for "Read & Get Properties" operations. If this property is not specified
|
||||
on the request, then the property will be cleared for the file. Subsequent calls to "Read & Get Properties" will not return this property unless it is explicitly set on that file again.
|
||||
serializedName: x-ms-content-md5
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4069,9 +4069,10 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-properties
|
||||
description: >-
|
||||
Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string
|
||||
may only contain ASCII characters in the ISO-8859-1 character set. Valid only for the setProperties operation. If the file or directory exists, any properties not included in the list will be removed. All properties are removed
|
||||
if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.
|
||||
Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the
|
||||
string may only contain ASCII characters in the ISO-8859-1 character set. Valid only for the setProperties operation. If the file or directory exists, any properties not included in the list will be removed. All
|
||||
properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all
|
||||
properties.
|
||||
serializedName: x-ms-properties
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4105,8 +4106,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-permissions
|
||||
description: >-
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission.
|
||||
The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. Invalid in conjunction with x-ms-acl.
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute
|
||||
permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. Invalid in conjunction with x-ms-acl.
|
||||
serializedName: x-ms-permissions
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4118,14 +4119,14 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-acl
|
||||
description: >-
|
||||
Optional and valid only for the setAccessControl operation. Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries that fully replaces the existing access control
|
||||
list (ACL). Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]". The scope must be "default" to indicate the ACE belongs to
|
||||
the default ACL for a directory; otherwise scope is implicit and the ACE belongs to the access ACL. There are four ACE types: "user" grants rights to the owner or a named user, "group" grants rights to the owning group or a
|
||||
named group, "mask" restricts rights granted to named users and the members of groups, and "other" grants rights to all users not found in any of the other entries. The user or group identifier is omitted for entries of type
|
||||
"mask" and "other". The user or group identifier is also omitted for the owner and owning group. The permission field is a 3-character sequence where the first character is 'r' to grant read access, the second character is 'w'
|
||||
to grant write access, and the third character is 'x' to grant execute permission. If access is not granted, the '-' character is used to denote that the permission is denied. For example, the following ACL grants read, write,
|
||||
and execute rights to the file owner and john.doe@contoso, the read right to the owning group, and nothing to everyone else: "user::rwx,user:john.doe@contoso:rwx,group::r--,other::---,mask=rwx". Invalid in conjunction with
|
||||
x-ms-permissions.
|
||||
Optional and valid only for the setAccessControl operation. Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries that fully replaces the existing access
|
||||
control list (ACL). Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]". The scope must be "default" to indicate the
|
||||
ACE belongs to the default ACL for a directory; otherwise scope is implicit and the ACE belongs to the access ACL. There are four ACE types: "user" grants rights to the owner or a named user, "group" grants rights to the
|
||||
owning group or a named group, "mask" restricts rights granted to named users and the members of groups, and "other" grants rights to all users not found in any of the other entries. The user or group identifier is omitted
|
||||
for entries of type "mask" and "other". The user or group identifier is also omitted for the owner and owning group. The permission field is a 3-character sequence where the first character is 'r' to grant read access,
|
||||
the second character is 'w' to grant write access, and the third character is 'x' to grant execute permission. If access is not granted, the '-' character is used to denote that the permission is denied. For example, the
|
||||
following ACL grants read, write, and execute rights to the file owner and john.doe@contoso, the read right to the owning group, and nothing to everyone else:
|
||||
"user::rwx,user:john.doe@contoso:rwx,group::r--,other::---,mask=rwx". Invalid in conjunction with x-ms-permissions.
|
||||
serializedName: x-ms-acl
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4136,7 +4137,9 @@ operationGroups:
|
|||
language: !<!Languages>
|
||||
default:
|
||||
name: If-Match
|
||||
description: 'Optional for Flush Data and Set Properties, but invalid for Append Data. An ETag value. Specify this header to perform the operation only if the resource''s ETag matches the value specified. The ETag must be specified in quotes.'
|
||||
description: >-
|
||||
Optional for Flush Data and Set Properties, but invalid for Append Data. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in
|
||||
quotes.
|
||||
serializedName: If-Match
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4446,10 +4449,10 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-lease-action
|
||||
description: >-
|
||||
There are five lease actions: "acquire", "break", "change", "renew", and "release". Use "acquire" and specify the "x-ms-proposed-lease-id" and "x-ms-lease-duration" to acquire a new lease. Use "break" to break an existing lease.
|
||||
When a lease is broken, the lease break period is allowed to elapse, during which time no lease operation except break and release can be performed on the file. When a lease is successfully broken, the response indicates the
|
||||
interval in seconds until a new lease can be acquired. Use "change" and specify the current lease ID in "x-ms-lease-id" and the new lease ID in "x-ms-proposed-lease-id" to change the lease ID of an active lease. Use "renew" and
|
||||
specify the "x-ms-lease-id" to renew an existing lease. Use "release" and specify the "x-ms-lease-id" to release a lease.
|
||||
There are five lease actions: "acquire", "break", "change", "renew", and "release". Use "acquire" and specify the "x-ms-proposed-lease-id" and "x-ms-lease-duration" to acquire a new lease. Use "break" to break an existing
|
||||
lease. When a lease is broken, the lease break period is allowed to elapse, during which time no lease operation except break and release can be performed on the file. When a lease is successfully broken, the response
|
||||
indicates the interval in seconds until a new lease can be acquired. Use "change" and specify the current lease ID in "x-ms-lease-id" and the new lease ID in "x-ms-proposed-lease-id" to change the lease ID of an active
|
||||
lease. Use "renew" and specify the "x-ms-lease-id" to renew an existing lease. Use "release" and specify the "x-ms-lease-id" to release a lease.
|
||||
serializedName: x-ms-lease-action
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4764,8 +4767,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-lease-id
|
||||
description: >-
|
||||
Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of the
|
||||
path.
|
||||
Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of
|
||||
the path.
|
||||
serializedName: x-ms-lease-id
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4777,8 +4780,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-range-get-content-md5
|
||||
description: >-
|
||||
Optional. When this header is set to "true" and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4MB in size. If this header is specified
|
||||
without the Range header, the service returns status code 400 (Bad Request). If this header is set to true when the range exceeds 4 MB in size, the service returns status code 400 (Bad Request).
|
||||
Optional. When this header is set to "true" and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4MB in size. If this header is
|
||||
specified without the Range header, the service returns status code 400 (Bad Request). If this header is set to true when the range exceeds 4 MB in size, the service returns status code 400 (Bad Request).
|
||||
serializedName: x-ms-range-get-content-md5
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -5247,8 +5250,8 @@ operationGroups:
|
|||
default:
|
||||
name: action
|
||||
description: >-
|
||||
Optional. If the value is "getStatus" only the system defined properties for the path are returned. If the value is "getAccessControl" the access control list is returned in the response headers (Hierarchical Namespace must be
|
||||
enabled for the account), otherwise the properties are returned.
|
||||
Optional. If the value is "getStatus" only the system defined properties for the path are returned. If the value is "getAccessControl" the access control list is returned in the response headers (Hierarchical Namespace
|
||||
must be enabled for the account), otherwise the properties are returned.
|
||||
serializedName: action
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -5261,8 +5264,8 @@ operationGroups:
|
|||
name: upn
|
||||
description: >-
|
||||
Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active
|
||||
Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they
|
||||
do not have unique friendly names.
|
||||
Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because
|
||||
they do not have unique friendly names.
|
||||
serializedName: upn
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -5285,8 +5288,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-lease-id
|
||||
description: >-
|
||||
Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of the
|
||||
path.
|
||||
Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of
|
||||
the path.
|
||||
serializedName: x-ms-lease-id
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -5555,8 +5558,8 @@ operationGroups:
|
|||
default:
|
||||
name: continuation
|
||||
description: >-
|
||||
Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header.
|
||||
When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.
|
||||
Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response
|
||||
header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.
|
||||
serializedName: continuation
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
|
|||
|
|
@ -2366,8 +2366,8 @@ operationGroups:
|
|||
default:
|
||||
name: continuation
|
||||
description: >-
|
||||
The number of filesystems returned with each invocation is limited. If the number of filesystems to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation
|
||||
token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems.
|
||||
The number of filesystems returned with each invocation is limited. If the number of filesystems to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a
|
||||
continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems.
|
||||
serializedName: continuation
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2516,8 +2516,8 @@ operationGroups:
|
|||
default:
|
||||
name: filesystem
|
||||
description: >-
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The
|
||||
value must have between 3 and 63 characters.
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase.
|
||||
The value must have between 3 and 63 characters.
|
||||
serializedName: filesystem
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2577,8 +2577,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-properties
|
||||
description: >-
|
||||
User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only contain
|
||||
ASCII characters in the ISO-8859-1 character set.
|
||||
User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only
|
||||
contain ASCII characters in the ISO-8859-1 character set.
|
||||
serializedName: x-ms-properties
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2671,8 +2671,8 @@ operationGroups:
|
|||
default:
|
||||
name: filesystem
|
||||
description: >-
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The
|
||||
value must have between 3 and 63 characters.
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase.
|
||||
The value must have between 3 and 63 characters.
|
||||
serializedName: filesystem
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2732,9 +2732,9 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-properties
|
||||
description: >-
|
||||
Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only
|
||||
contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing
|
||||
properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.
|
||||
Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may
|
||||
only contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and
|
||||
existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.
|
||||
serializedName: x-ms-properties
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2850,8 +2850,8 @@ operationGroups:
|
|||
default:
|
||||
name: filesystem
|
||||
description: >-
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The
|
||||
value must have between 3 and 63 characters.
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase.
|
||||
The value must have between 3 and 63 characters.
|
||||
serializedName: filesystem
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2994,8 +2994,8 @@ operationGroups:
|
|||
default:
|
||||
name: filesystem
|
||||
description: >-
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The
|
||||
value must have between 3 and 63 characters.
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase.
|
||||
The value must have between 3 and 63 characters.
|
||||
serializedName: filesystem
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3135,8 +3135,8 @@ operationGroups:
|
|||
description: >-
|
||||
Marks the filesystem for deletion. When a filesystem is deleted, a filesystem with the same identifier cannot be created for at least 30 seconds. While the filesystem is being deleted, attempts to create a filesystem with the
|
||||
same identifier will fail with status code 409 (Conflict), with the service returning additional error information indicating that the filesystem is being deleted. All other operations, including operations on any files or
|
||||
directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for
|
||||
Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers
|
||||
for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Delete Filesystem
|
||||
protocol: !<!Protocols> {}
|
||||
language: !<!Languages>
|
||||
|
|
@ -3162,8 +3162,8 @@ operationGroups:
|
|||
default:
|
||||
name: filesystem
|
||||
description: >-
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The
|
||||
value must have between 3 and 63 characters.
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase.
|
||||
The value must have between 3 and 63 characters.
|
||||
serializedName: filesystem
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3246,8 +3246,8 @@ operationGroups:
|
|||
default:
|
||||
name: continuation
|
||||
description: >-
|
||||
The number of paths returned with each invocation is limited. If the number of paths to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is
|
||||
returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.
|
||||
The number of paths returned with each invocation is limited. If the number of paths to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token
|
||||
is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.
|
||||
serializedName: continuation
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3270,9 +3270,9 @@ operationGroups:
|
|||
default:
|
||||
name: upn
|
||||
description: >-
|
||||
Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory Object
|
||||
IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have
|
||||
unique friendly names.
|
||||
Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory
|
||||
Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do
|
||||
not have unique friendly names.
|
||||
serializedName: upn
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3450,8 +3450,8 @@ operationGroups:
|
|||
default:
|
||||
name: continuation
|
||||
description: >-
|
||||
Optional. When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header.
|
||||
When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.
|
||||
Optional. When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response
|
||||
header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.
|
||||
serializedName: continuation
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3573,8 +3573,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-rename-source
|
||||
description: >-
|
||||
An optional file or directory to be renamed. The value must have the following format: "/{filesystem}/{path}". If "x-ms-properties" is specified, the properties will overwrite the existing properties; otherwise, the existing
|
||||
properties will be preserved. This value must be a URL percent-encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.
|
||||
An optional file or directory to be renamed. The value must have the following format: "/{filesystem}/{path}". If "x-ms-properties" is specified, the properties will overwrite the existing properties; otherwise, the
|
||||
existing properties will be preserved. This value must be a URL percent-encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.
|
||||
serializedName: x-ms-rename-source
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3608,8 +3608,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-properties
|
||||
description: >-
|
||||
Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string
|
||||
may only contain ASCII characters in the ISO-8859-1 character set.
|
||||
Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the
|
||||
string may only contain ASCII characters in the ISO-8859-1 character set.
|
||||
serializedName: x-ms-properties
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3621,8 +3621,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-permissions
|
||||
description: >-
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission.
|
||||
The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute
|
||||
permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.
|
||||
serializedName: x-ms-permissions
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3634,9 +3634,9 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-umask
|
||||
description: >-
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the permissions of the file or directory to
|
||||
be created. The resulting permission is given by p & ^u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission is 0777 for a
|
||||
directory and 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766).
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the permissions of the file or
|
||||
directory to be created. The resulting permission is given by p & ^u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission
|
||||
is 0777 for a directory and 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766).
|
||||
serializedName: x-ms-umask
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3909,9 +3909,9 @@ operationGroups:
|
|||
default:
|
||||
name: action
|
||||
description: >-
|
||||
The action must be "append" to upload data to be appended to a file, "flush" to flush previously uploaded data to a file, "setProperties" to set the properties of a file or directory, or "setAccessControl" to set the owner,
|
||||
group, permissions, or access control list for a file or directory. Note that Hierarchical Namespace must be enabled for the account in order to use access control. Also note that the Access Control List (ACL) includes
|
||||
permissions for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers are mutually exclusive.
|
||||
The action must be "append" to upload data to be appended to a file, "flush" to flush previously uploaded data to a file, "setProperties" to set the properties of a file or directory, or "setAccessControl" to set the
|
||||
owner, group, permissions, or access control list for a file or directory. Note that Hierarchical Namespace must be enabled for the account in order to use access control. Also note that the Access Control List (ACL)
|
||||
includes permissions for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers are mutually exclusive.
|
||||
serializedName: action
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3923,9 +3923,9 @@ operationGroups:
|
|||
default:
|
||||
name: position
|
||||
description: >-
|
||||
This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded data to
|
||||
the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the position parameter
|
||||
must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request.
|
||||
This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded
|
||||
data to the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the
|
||||
position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request.
|
||||
serializedName: position
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3937,8 +3937,8 @@ operationGroups:
|
|||
default:
|
||||
name: retainUncommittedData
|
||||
description: >-
|
||||
Valid only for flush operations. If "true", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets less
|
||||
than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation.
|
||||
Valid only for flush operations. If "true", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets
|
||||
less than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation.
|
||||
serializedName: retainUncommittedData
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3950,10 +3950,10 @@ operationGroups:
|
|||
default:
|
||||
name: close
|
||||
description: >-
|
||||
Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final change to
|
||||
distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is "flush" and change notifications are enabled. If the
|
||||
value of close is "true" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been closed). If "false" a
|
||||
change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed."
|
||||
Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final
|
||||
change to distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is "flush" and change notifications are
|
||||
enabled. If the value of close is "true" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been
|
||||
closed). If "false" a change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed."
|
||||
serializedName: close
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3976,9 +3976,9 @@ operationGroups:
|
|||
default:
|
||||
name: Content-MD5
|
||||
description: >-
|
||||
Optional. An MD5 hash of the request content. This header is valid on "Append" and "Flush" operations. This hash is used to verify the integrity of the request content during transport. When this header is specified, the storage
|
||||
service compares the hash of the content that has arrived with this header value. If the two hashes do not match, the operation will fail with error code 400 (Bad Request). Note that this MD5 hash is not stored with the file.
|
||||
This header is associated with the request content, and not with the stored content of the file itself.
|
||||
Optional. An MD5 hash of the request content. This header is valid on "Append" and "Flush" operations. This hash is used to verify the integrity of the request content during transport. When this header is specified, the
|
||||
storage service compares the hash of the content that has arrived with this header value. If the two hashes do not match, the operation will fail with error code 400 (Bad Request). Note that this MD5 hash is not stored
|
||||
with the file. This header is associated with the request content, and not with the stored content of the file itself.
|
||||
serializedName: Content-MD5
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4056,8 +4056,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-content-md5
|
||||
description: >-
|
||||
Optional and only valid for "Flush & Set Properties" operations. The service stores this value and includes it in the "Content-Md5" response header for "Read & Get Properties" operations. If this property is not specified on
|
||||
the request, then the property will be cleared for the file. Subsequent calls to "Read & Get Properties" will not return this property unless it is explicitly set on that file again.
|
||||
Optional and only valid for "Flush & Set Properties" operations. The service stores this value and includes it in the "Content-Md5" response header for "Read & Get Properties" operations. If this property is not specified
|
||||
on the request, then the property will be cleared for the file. Subsequent calls to "Read & Get Properties" will not return this property unless it is explicitly set on that file again.
|
||||
serializedName: x-ms-content-md5
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4069,9 +4069,10 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-properties
|
||||
description: >-
|
||||
Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string
|
||||
may only contain ASCII characters in the ISO-8859-1 character set. Valid only for the setProperties operation. If the file or directory exists, any properties not included in the list will be removed. All properties are removed
|
||||
if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.
|
||||
Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the
|
||||
string may only contain ASCII characters in the ISO-8859-1 character set. Valid only for the setProperties operation. If the file or directory exists, any properties not included in the list will be removed. All
|
||||
properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all
|
||||
properties.
|
||||
serializedName: x-ms-properties
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4105,8 +4106,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-permissions
|
||||
description: >-
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission.
|
||||
The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. Invalid in conjunction with x-ms-acl.
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute
|
||||
permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. Invalid in conjunction with x-ms-acl.
|
||||
serializedName: x-ms-permissions
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4118,14 +4119,14 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-acl
|
||||
description: >-
|
||||
Optional and valid only for the setAccessControl operation. Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries that fully replaces the existing access control
|
||||
list (ACL). Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]". The scope must be "default" to indicate the ACE belongs to
|
||||
the default ACL for a directory; otherwise scope is implicit and the ACE belongs to the access ACL. There are four ACE types: "user" grants rights to the owner or a named user, "group" grants rights to the owning group or a
|
||||
named group, "mask" restricts rights granted to named users and the members of groups, and "other" grants rights to all users not found in any of the other entries. The user or group identifier is omitted for entries of type
|
||||
"mask" and "other". The user or group identifier is also omitted for the owner and owning group. The permission field is a 3-character sequence where the first character is 'r' to grant read access, the second character is 'w'
|
||||
to grant write access, and the third character is 'x' to grant execute permission. If access is not granted, the '-' character is used to denote that the permission is denied. For example, the following ACL grants read, write,
|
||||
and execute rights to the file owner and john.doe@contoso, the read right to the owning group, and nothing to everyone else: "user::rwx,user:john.doe@contoso:rwx,group::r--,other::---,mask=rwx". Invalid in conjunction with
|
||||
x-ms-permissions.
|
||||
Optional and valid only for the setAccessControl operation. Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries that fully replaces the existing access
|
||||
control list (ACL). Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]". The scope must be "default" to indicate the
|
||||
ACE belongs to the default ACL for a directory; otherwise scope is implicit and the ACE belongs to the access ACL. There are four ACE types: "user" grants rights to the owner or a named user, "group" grants rights to the
|
||||
owning group or a named group, "mask" restricts rights granted to named users and the members of groups, and "other" grants rights to all users not found in any of the other entries. The user or group identifier is omitted
|
||||
for entries of type "mask" and "other". The user or group identifier is also omitted for the owner and owning group. The permission field is a 3-character sequence where the first character is 'r' to grant read access,
|
||||
the second character is 'w' to grant write access, and the third character is 'x' to grant execute permission. If access is not granted, the '-' character is used to denote that the permission is denied. For example, the
|
||||
following ACL grants read, write, and execute rights to the file owner and john.doe@contoso, the read right to the owning group, and nothing to everyone else:
|
||||
"user::rwx,user:john.doe@contoso:rwx,group::r--,other::---,mask=rwx". Invalid in conjunction with x-ms-permissions.
|
||||
serializedName: x-ms-acl
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4136,7 +4137,9 @@ operationGroups:
|
|||
language: !<!Languages>
|
||||
default:
|
||||
name: If-Match
|
||||
description: 'Optional for Flush Data and Set Properties, but invalid for Append Data. An ETag value. Specify this header to perform the operation only if the resource''s ETag matches the value specified. The ETag must be specified in quotes.'
|
||||
description: >-
|
||||
Optional for Flush Data and Set Properties, but invalid for Append Data. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in
|
||||
quotes.
|
||||
serializedName: If-Match
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4446,10 +4449,10 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-lease-action
|
||||
description: >-
|
||||
There are five lease actions: "acquire", "break", "change", "renew", and "release". Use "acquire" and specify the "x-ms-proposed-lease-id" and "x-ms-lease-duration" to acquire a new lease. Use "break" to break an existing lease.
|
||||
When a lease is broken, the lease break period is allowed to elapse, during which time no lease operation except break and release can be performed on the file. When a lease is successfully broken, the response indicates the
|
||||
interval in seconds until a new lease can be acquired. Use "change" and specify the current lease ID in "x-ms-lease-id" and the new lease ID in "x-ms-proposed-lease-id" to change the lease ID of an active lease. Use "renew" and
|
||||
specify the "x-ms-lease-id" to renew an existing lease. Use "release" and specify the "x-ms-lease-id" to release a lease.
|
||||
There are five lease actions: "acquire", "break", "change", "renew", and "release". Use "acquire" and specify the "x-ms-proposed-lease-id" and "x-ms-lease-duration" to acquire a new lease. Use "break" to break an existing
|
||||
lease. When a lease is broken, the lease break period is allowed to elapse, during which time no lease operation except break and release can be performed on the file. When a lease is successfully broken, the response
|
||||
indicates the interval in seconds until a new lease can be acquired. Use "change" and specify the current lease ID in "x-ms-lease-id" and the new lease ID in "x-ms-proposed-lease-id" to change the lease ID of an active
|
||||
lease. Use "renew" and specify the "x-ms-lease-id" to renew an existing lease. Use "release" and specify the "x-ms-lease-id" to release a lease.
|
||||
serializedName: x-ms-lease-action
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4764,8 +4767,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-lease-id
|
||||
description: >-
|
||||
Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of the
|
||||
path.
|
||||
Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of
|
||||
the path.
|
||||
serializedName: x-ms-lease-id
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4777,8 +4780,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-range-get-content-md5
|
||||
description: >-
|
||||
Optional. When this header is set to "true" and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4MB in size. If this header is specified
|
||||
without the Range header, the service returns status code 400 (Bad Request). If this header is set to true when the range exceeds 4 MB in size, the service returns status code 400 (Bad Request).
|
||||
Optional. When this header is set to "true" and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4MB in size. If this header is
|
||||
specified without the Range header, the service returns status code 400 (Bad Request). If this header is set to true when the range exceeds 4 MB in size, the service returns status code 400 (Bad Request).
|
||||
serializedName: x-ms-range-get-content-md5
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -5247,8 +5250,8 @@ operationGroups:
|
|||
default:
|
||||
name: action
|
||||
description: >-
|
||||
Optional. If the value is "getStatus" only the system defined properties for the path are returned. If the value is "getAccessControl" the access control list is returned in the response headers (Hierarchical Namespace must be
|
||||
enabled for the account), otherwise the properties are returned.
|
||||
Optional. If the value is "getStatus" only the system defined properties for the path are returned. If the value is "getAccessControl" the access control list is returned in the response headers (Hierarchical Namespace
|
||||
must be enabled for the account), otherwise the properties are returned.
|
||||
serializedName: action
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -5261,8 +5264,8 @@ operationGroups:
|
|||
name: upn
|
||||
description: >-
|
||||
Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active
|
||||
Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they
|
||||
do not have unique friendly names.
|
||||
Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because
|
||||
they do not have unique friendly names.
|
||||
serializedName: upn
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -5285,8 +5288,8 @@ operationGroups:
|
|||
default:
|
||||
name: x-ms-lease-id
|
||||
description: >-
|
||||
Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of the
|
||||
path.
|
||||
Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of
|
||||
the path.
|
||||
serializedName: x-ms-lease-id
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -5555,8 +5558,8 @@ operationGroups:
|
|||
default:
|
||||
name: continuation
|
||||
description: >-
|
||||
Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header.
|
||||
When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.
|
||||
Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response
|
||||
header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.
|
||||
serializedName: continuation
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
|
|||
|
|
@ -2366,8 +2366,8 @@ operationGroups:
|
|||
default:
|
||||
name: continuation
|
||||
description: >-
|
||||
The number of filesystems returned with each invocation is limited. If the number of filesystems to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation
|
||||
token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems.
|
||||
The number of filesystems returned with each invocation is limited. If the number of filesystems to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a
|
||||
continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems.
|
||||
serializedName: continuation
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2516,8 +2516,8 @@ operationGroups:
|
|||
default:
|
||||
name: filesystem
|
||||
description: >-
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The
|
||||
value must have between 3 and 63 characters.
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase.
|
||||
The value must have between 3 and 63 characters.
|
||||
serializedName: filesystem
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2577,8 +2577,8 @@ operationGroups:
|
|||
default:
|
||||
name: xMsProperties
|
||||
description: >-
|
||||
User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only contain
|
||||
ASCII characters in the ISO-8859-1 character set.
|
||||
User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only
|
||||
contain ASCII characters in the ISO-8859-1 character set.
|
||||
serializedName: x-ms-properties
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2671,8 +2671,8 @@ operationGroups:
|
|||
default:
|
||||
name: filesystem
|
||||
description: >-
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The
|
||||
value must have between 3 and 63 characters.
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase.
|
||||
The value must have between 3 and 63 characters.
|
||||
serializedName: filesystem
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2732,9 +2732,9 @@ operationGroups:
|
|||
default:
|
||||
name: xMsProperties
|
||||
description: >-
|
||||
Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only
|
||||
contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing
|
||||
properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.
|
||||
Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may
|
||||
only contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and
|
||||
existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.
|
||||
serializedName: x-ms-properties
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2850,8 +2850,8 @@ operationGroups:
|
|||
default:
|
||||
name: filesystem
|
||||
description: >-
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The
|
||||
value must have between 3 and 63 characters.
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase.
|
||||
The value must have between 3 and 63 characters.
|
||||
serializedName: filesystem
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -2994,8 +2994,8 @@ operationGroups:
|
|||
default:
|
||||
name: filesystem
|
||||
description: >-
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The
|
||||
value must have between 3 and 63 characters.
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase.
|
||||
The value must have between 3 and 63 characters.
|
||||
serializedName: filesystem
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3135,8 +3135,8 @@ operationGroups:
|
|||
description: >-
|
||||
Marks the filesystem for deletion. When a filesystem is deleted, a filesystem with the same identifier cannot be created for at least 30 seconds. While the filesystem is being deleted, attempts to create a filesystem with the
|
||||
same identifier will fail with status code 409 (Conflict), with the service returning additional error information indicating that the filesystem is being deleted. All other operations, including operations on any files or
|
||||
directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for
|
||||
Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers
|
||||
for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Delete Filesystem
|
||||
protocol: !<!Protocols> {}
|
||||
language: !<!Languages>
|
||||
|
|
@ -3162,8 +3162,8 @@ operationGroups:
|
|||
default:
|
||||
name: filesystem
|
||||
description: >-
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The
|
||||
value must have between 3 and 63 characters.
|
||||
The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase.
|
||||
The value must have between 3 and 63 characters.
|
||||
serializedName: filesystem
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3246,8 +3246,8 @@ operationGroups:
|
|||
default:
|
||||
name: continuation
|
||||
description: >-
|
||||
The number of paths returned with each invocation is limited. If the number of paths to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is
|
||||
returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.
|
||||
The number of paths returned with each invocation is limited. If the number of paths to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token
|
||||
is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.
|
||||
serializedName: continuation
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3270,9 +3270,9 @@ operationGroups:
|
|||
default:
|
||||
name: upn
|
||||
description: >-
|
||||
Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory Object
|
||||
IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have
|
||||
unique friendly names.
|
||||
Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory
|
||||
Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do
|
||||
not have unique friendly names.
|
||||
serializedName: upn
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3450,8 +3450,8 @@ operationGroups:
|
|||
default:
|
||||
name: continuation
|
||||
description: >-
|
||||
Optional. When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header.
|
||||
When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.
|
||||
Optional. When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response
|
||||
header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.
|
||||
serializedName: continuation
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3573,8 +3573,8 @@ operationGroups:
|
|||
default:
|
||||
name: xMsRenameSource
|
||||
description: >-
|
||||
An optional file or directory to be renamed. The value must have the following format: "/{filesystem}/{path}". If "x-ms-properties" is specified, the properties will overwrite the existing properties; otherwise, the existing
|
||||
properties will be preserved. This value must be a URL percent-encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.
|
||||
An optional file or directory to be renamed. The value must have the following format: "/{filesystem}/{path}". If "x-ms-properties" is specified, the properties will overwrite the existing properties; otherwise, the
|
||||
existing properties will be preserved. This value must be a URL percent-encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.
|
||||
serializedName: x-ms-rename-source
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3608,8 +3608,8 @@ operationGroups:
|
|||
default:
|
||||
name: xMsProperties
|
||||
description: >-
|
||||
Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string
|
||||
may only contain ASCII characters in the ISO-8859-1 character set.
|
||||
Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the
|
||||
string may only contain ASCII characters in the ISO-8859-1 character set.
|
||||
serializedName: x-ms-properties
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3621,8 +3621,8 @@ operationGroups:
|
|||
default:
|
||||
name: xMsPermissions
|
||||
description: >-
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission.
|
||||
The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute
|
||||
permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.
|
||||
serializedName: x-ms-permissions
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3634,9 +3634,9 @@ operationGroups:
|
|||
default:
|
||||
name: xMsUmask
|
||||
description: >-
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the permissions of the file or directory to
|
||||
be created. The resulting permission is given by p & ^u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission is 0777 for a
|
||||
directory and 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766).
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the permissions of the file or
|
||||
directory to be created. The resulting permission is given by p & ^u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission
|
||||
is 0777 for a directory and 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766).
|
||||
serializedName: x-ms-umask
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3909,9 +3909,9 @@ operationGroups:
|
|||
default:
|
||||
name: action
|
||||
description: >-
|
||||
The action must be "append" to upload data to be appended to a file, "flush" to flush previously uploaded data to a file, "setProperties" to set the properties of a file or directory, or "setAccessControl" to set the owner,
|
||||
group, permissions, or access control list for a file or directory. Note that Hierarchical Namespace must be enabled for the account in order to use access control. Also note that the Access Control List (ACL) includes
|
||||
permissions for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers are mutually exclusive.
|
||||
The action must be "append" to upload data to be appended to a file, "flush" to flush previously uploaded data to a file, "setProperties" to set the properties of a file or directory, or "setAccessControl" to set the
|
||||
owner, group, permissions, or access control list for a file or directory. Note that Hierarchical Namespace must be enabled for the account in order to use access control. Also note that the Access Control List (ACL)
|
||||
includes permissions for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers are mutually exclusive.
|
||||
serializedName: action
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3923,9 +3923,9 @@ operationGroups:
|
|||
default:
|
||||
name: position
|
||||
description: >-
|
||||
This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded data to
|
||||
the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the position parameter
|
||||
must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request.
|
||||
This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded
|
||||
data to the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the
|
||||
position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request.
|
||||
serializedName: position
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3937,8 +3937,8 @@ operationGroups:
|
|||
default:
|
||||
name: retainUncommittedData
|
||||
description: >-
|
||||
Valid only for flush operations. If "true", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets less
|
||||
than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation.
|
||||
Valid only for flush operations. If "true", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets
|
||||
less than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation.
|
||||
serializedName: retainUncommittedData
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3950,10 +3950,10 @@ operationGroups:
|
|||
default:
|
||||
name: close
|
||||
description: >-
|
||||
Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final change to
|
||||
distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is "flush" and change notifications are enabled. If the
|
||||
value of close is "true" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been closed). If "false" a
|
||||
change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed."
|
||||
Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final
|
||||
change to distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is "flush" and change notifications are
|
||||
enabled. If the value of close is "true" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been
|
||||
closed). If "false" a change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed."
|
||||
serializedName: close
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -3976,9 +3976,9 @@ operationGroups:
|
|||
default:
|
||||
name: contentMD5
|
||||
description: >-
|
||||
Optional. An MD5 hash of the request content. This header is valid on "Append" and "Flush" operations. This hash is used to verify the integrity of the request content during transport. When this header is specified, the storage
|
||||
service compares the hash of the content that has arrived with this header value. If the two hashes do not match, the operation will fail with error code 400 (Bad Request). Note that this MD5 hash is not stored with the file.
|
||||
This header is associated with the request content, and not with the stored content of the file itself.
|
||||
Optional. An MD5 hash of the request content. This header is valid on "Append" and "Flush" operations. This hash is used to verify the integrity of the request content during transport. When this header is specified, the
|
||||
storage service compares the hash of the content that has arrived with this header value. If the two hashes do not match, the operation will fail with error code 400 (Bad Request). Note that this MD5 hash is not stored
|
||||
with the file. This header is associated with the request content, and not with the stored content of the file itself.
|
||||
serializedName: Content-MD5
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4056,8 +4056,8 @@ operationGroups:
|
|||
default:
|
||||
name: xMsContentMd5
|
||||
description: >-
|
||||
Optional and only valid for "Flush & Set Properties" operations. The service stores this value and includes it in the "Content-Md5" response header for "Read & Get Properties" operations. If this property is not specified on
|
||||
the request, then the property will be cleared for the file. Subsequent calls to "Read & Get Properties" will not return this property unless it is explicitly set on that file again.
|
||||
Optional and only valid for "Flush & Set Properties" operations. The service stores this value and includes it in the "Content-Md5" response header for "Read & Get Properties" operations. If this property is not specified
|
||||
on the request, then the property will be cleared for the file. Subsequent calls to "Read & Get Properties" will not return this property unless it is explicitly set on that file again.
|
||||
serializedName: x-ms-content-md5
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4069,9 +4069,10 @@ operationGroups:
|
|||
default:
|
||||
name: xMsProperties
|
||||
description: >-
|
||||
Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string
|
||||
may only contain ASCII characters in the ISO-8859-1 character set. Valid only for the setProperties operation. If the file or directory exists, any properties not included in the list will be removed. All properties are removed
|
||||
if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.
|
||||
Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the
|
||||
string may only contain ASCII characters in the ISO-8859-1 character set. Valid only for the setProperties operation. If the file or directory exists, any properties not included in the list will be removed. All
|
||||
properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all
|
||||
properties.
|
||||
serializedName: x-ms-properties
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4105,8 +4106,8 @@ operationGroups:
|
|||
default:
|
||||
name: xMsPermissions
|
||||
description: >-
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission.
|
||||
The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. Invalid in conjunction with x-ms-acl.
|
||||
Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute
|
||||
permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. Invalid in conjunction with x-ms-acl.
|
||||
serializedName: x-ms-permissions
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4118,14 +4119,14 @@ operationGroups:
|
|||
default:
|
||||
name: xMsAcl
|
||||
description: >-
|
||||
Optional and valid only for the setAccessControl operation. Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries that fully replaces the existing access control
|
||||
list (ACL). Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]". The scope must be "default" to indicate the ACE belongs to
|
||||
the default ACL for a directory; otherwise scope is implicit and the ACE belongs to the access ACL. There are four ACE types: "user" grants rights to the owner or a named user, "group" grants rights to the owning group or a
|
||||
named group, "mask" restricts rights granted to named users and the members of groups, and "other" grants rights to all users not found in any of the other entries. The user or group identifier is omitted for entries of type
|
||||
"mask" and "other". The user or group identifier is also omitted for the owner and owning group. The permission field is a 3-character sequence where the first character is 'r' to grant read access, the second character is 'w'
|
||||
to grant write access, and the third character is 'x' to grant execute permission. If access is not granted, the '-' character is used to denote that the permission is denied. For example, the following ACL grants read, write,
|
||||
and execute rights to the file owner and john.doe@contoso, the read right to the owning group, and nothing to everyone else: "user::rwx,user:john.doe@contoso:rwx,group::r--,other::---,mask=rwx". Invalid in conjunction with
|
||||
x-ms-permissions.
|
||||
Optional and valid only for the setAccessControl operation. Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries that fully replaces the existing access
|
||||
control list (ACL). Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]". The scope must be "default" to indicate the
|
||||
ACE belongs to the default ACL for a directory; otherwise scope is implicit and the ACE belongs to the access ACL. There are four ACE types: "user" grants rights to the owner or a named user, "group" grants rights to the
|
||||
owning group or a named group, "mask" restricts rights granted to named users and the members of groups, and "other" grants rights to all users not found in any of the other entries. The user or group identifier is omitted
|
||||
for entries of type "mask" and "other". The user or group identifier is also omitted for the owner and owning group. The permission field is a 3-character sequence where the first character is 'r' to grant read access,
|
||||
the second character is 'w' to grant write access, and the third character is 'x' to grant execute permission. If access is not granted, the '-' character is used to denote that the permission is denied. For example, the
|
||||
following ACL grants read, write, and execute rights to the file owner and john.doe@contoso, the read right to the owning group, and nothing to everyone else:
|
||||
"user::rwx,user:john.doe@contoso:rwx,group::r--,other::---,mask=rwx". Invalid in conjunction with x-ms-permissions.
|
||||
serializedName: x-ms-acl
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4136,7 +4137,9 @@ operationGroups:
|
|||
language: !<!Languages>
|
||||
default:
|
||||
name: ifMatch
|
||||
description: 'Optional for Flush Data and Set Properties, but invalid for Append Data. An ETag value. Specify this header to perform the operation only if the resource''s ETag matches the value specified. The ETag must be specified in quotes.'
|
||||
description: >-
|
||||
Optional for Flush Data and Set Properties, but invalid for Append Data. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in
|
||||
quotes.
|
||||
serializedName: If-Match
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4446,10 +4449,10 @@ operationGroups:
|
|||
default:
|
||||
name: xMsLeaseAction
|
||||
description: >-
|
||||
There are five lease actions: "acquire", "break", "change", "renew", and "release". Use "acquire" and specify the "x-ms-proposed-lease-id" and "x-ms-lease-duration" to acquire a new lease. Use "break" to break an existing lease.
|
||||
When a lease is broken, the lease break period is allowed to elapse, during which time no lease operation except break and release can be performed on the file. When a lease is successfully broken, the response indicates the
|
||||
interval in seconds until a new lease can be acquired. Use "change" and specify the current lease ID in "x-ms-lease-id" and the new lease ID in "x-ms-proposed-lease-id" to change the lease ID of an active lease. Use "renew" and
|
||||
specify the "x-ms-lease-id" to renew an existing lease. Use "release" and specify the "x-ms-lease-id" to release a lease.
|
||||
There are five lease actions: "acquire", "break", "change", "renew", and "release". Use "acquire" and specify the "x-ms-proposed-lease-id" and "x-ms-lease-duration" to acquire a new lease. Use "break" to break an existing
|
||||
lease. When a lease is broken, the lease break period is allowed to elapse, during which time no lease operation except break and release can be performed on the file. When a lease is successfully broken, the response
|
||||
indicates the interval in seconds until a new lease can be acquired. Use "change" and specify the current lease ID in "x-ms-lease-id" and the new lease ID in "x-ms-proposed-lease-id" to change the lease ID of an active
|
||||
lease. Use "renew" and specify the "x-ms-lease-id" to renew an existing lease. Use "release" and specify the "x-ms-lease-id" to release a lease.
|
||||
serializedName: x-ms-lease-action
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4764,8 +4767,8 @@ operationGroups:
|
|||
default:
|
||||
name: xMsLeaseId
|
||||
description: >-
|
||||
Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of the
|
||||
path.
|
||||
Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of
|
||||
the path.
|
||||
serializedName: x-ms-lease-id
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -4777,8 +4780,8 @@ operationGroups:
|
|||
default:
|
||||
name: xMsRangeGetContentMd5
|
||||
description: >-
|
||||
Optional. When this header is set to "true" and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4MB in size. If this header is specified
|
||||
without the Range header, the service returns status code 400 (Bad Request). If this header is set to true when the range exceeds 4 MB in size, the service returns status code 400 (Bad Request).
|
||||
Optional. When this header is set to "true" and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4MB in size. If this header is
|
||||
specified without the Range header, the service returns status code 400 (Bad Request). If this header is set to true when the range exceeds 4 MB in size, the service returns status code 400 (Bad Request).
|
||||
serializedName: x-ms-range-get-content-md5
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -5247,8 +5250,8 @@ operationGroups:
|
|||
default:
|
||||
name: action
|
||||
description: >-
|
||||
Optional. If the value is "getStatus" only the system defined properties for the path are returned. If the value is "getAccessControl" the access control list is returned in the response headers (Hierarchical Namespace must be
|
||||
enabled for the account), otherwise the properties are returned.
|
||||
Optional. If the value is "getStatus" only the system defined properties for the path are returned. If the value is "getAccessControl" the access control list is returned in the response headers (Hierarchical Namespace
|
||||
must be enabled for the account), otherwise the properties are returned.
|
||||
serializedName: action
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -5261,8 +5264,8 @@ operationGroups:
|
|||
name: upn
|
||||
description: >-
|
||||
Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active
|
||||
Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they
|
||||
do not have unique friendly names.
|
||||
Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because
|
||||
they do not have unique friendly names.
|
||||
serializedName: upn
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -5285,8 +5288,8 @@ operationGroups:
|
|||
default:
|
||||
name: xMsLeaseId
|
||||
description: >-
|
||||
Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of the
|
||||
path.
|
||||
Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of
|
||||
the path.
|
||||
serializedName: x-ms-lease-id
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
@ -5555,8 +5558,8 @@ operationGroups:
|
|||
default:
|
||||
name: continuation
|
||||
description: >-
|
||||
Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header.
|
||||
When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.
|
||||
Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response
|
||||
header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.
|
||||
serializedName: continuation
|
||||
protocol: !<!Protocols>
|
||||
http: !<!HttpParameter>
|
||||
|
|
|
|||
|
|
@ -2236,8 +2236,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: recoveryLevel
|
||||
description: >-
|
||||
Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge
|
||||
the secret, at the end of the retention interval.
|
||||
Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system
|
||||
can purge the secret, at the end of the retention interval.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -2269,8 +2269,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: recoveryLevel
|
||||
description: >-
|
||||
Reflects the deletion recovery level currently in effect for certificates in the current vault. If it contains 'Purgeable', the certificate can be permanently deleted by a privileged user; otherwise, only the system
|
||||
can purge the certificate, at the end of the retention interval.
|
||||
Reflects the deletion recovery level currently in effect for certificates in the current vault. If it contains 'Purgeable', the certificate can be permanently deleted by a privileged user; otherwise, only
|
||||
the system can purge the certificate, at the end of the retention interval.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -2352,8 +2352,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: recoveryLevel
|
||||
description: >-
|
||||
Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key, at the
|
||||
end of the retention interval.
|
||||
Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key,
|
||||
at the end of the retention interval.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -5456,8 +5456,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: recoveryLevel
|
||||
description: >-
|
||||
Reflects the deletion recovery level currently in effect for storage accounts in the current vault. If it contains 'Purgeable' the storage account can be permanently deleted by a privileged user; otherwise, only the
|
||||
system can purge the storage account, at the end of the retention interval.
|
||||
Reflects the deletion recovery level currently in effect for storage accounts in the current vault. If it contains 'Purgeable' the storage account can be permanently deleted by a privileged user; otherwise,
|
||||
only the system can purge the storage account, at the end of the retention interval.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -6034,8 +6034,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: recoveryLevel
|
||||
description: >-
|
||||
Reflects the deletion recovery level currently in effect for SAS definitions in the current vault. If it contains 'Purgeable' the SAS definition can be permanently deleted by a privileged user; otherwise, only the
|
||||
system can purge the SAS definition, at the end of the retention interval.
|
||||
Reflects the deletion recovery level currently in effect for SAS definitions in the current vault. If it contains 'Purgeable' the SAS definition can be permanently deleted by a privileged user; otherwise, only
|
||||
the system can purge the SAS definition, at the end of the retention interval.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -7546,8 +7546,8 @@ operationGroups:
|
|||
default:
|
||||
name: GetKeys
|
||||
description: >-
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags
|
||||
are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and
|
||||
tags are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.
|
||||
paging:
|
||||
nextLinkName: nextLink
|
||||
summary: List keys in the specified vault.
|
||||
|
|
@ -7646,10 +7646,10 @@ operationGroups:
|
|||
name: BackupKey
|
||||
description: >-
|
||||
The Key Backup operation exports a key from Azure Key Vault in a protected form. Note that this operation does NOT return key material in a form that can be used outside the Azure Key Vault system, the returned key material is
|
||||
either protected to a Azure Key Vault HSM or to Azure Key Vault itself. The intent of this operation is to allow a client to GENERATE a key in one Azure Key Vault instance, BACKUP the key, and then RESTORE it into another Azure
|
||||
Key Vault instance. The BACKUP operation may be used to export, in protected form, any key type from Azure Key Vault. Individual versions of a key cannot be backed up. BACKUP / RESTORE can be performed within geographical
|
||||
boundaries only; meaning that a BACKUP from one geographical area cannot be restored to another geographical area. For example, a backup from the US geographical area cannot be restored in an EU geographical area. This operation
|
||||
requires the key/backup permission.
|
||||
either protected to a Azure Key Vault HSM or to Azure Key Vault itself. The intent of this operation is to allow a client to GENERATE a key in one Azure Key Vault instance, BACKUP the key, and then RESTORE it into another
|
||||
Azure Key Vault instance. The BACKUP operation may be used to export, in protected form, any key type from Azure Key Vault. Individual versions of a key cannot be backed up. BACKUP / RESTORE can be performed within
|
||||
geographical boundaries only; meaning that a BACKUP from one geographical area cannot be restored to another geographical area. For example, a backup from the US geographical area cannot be restored in an EU geographical area.
|
||||
This operation requires the key/backup permission.
|
||||
summary: Requests that a backup of the specified key be downloaded to the client.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -7785,10 +7785,11 @@ operationGroups:
|
|||
default:
|
||||
name: RestoreKey
|
||||
description: >-
|
||||
Imports a previously backed up key into Azure Key Vault, restoring the key, its key identifier, attributes and access control policies. The RESTORE operation may be used to import a previously backed up key. Individual versions of
|
||||
a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the RESTORE operation will be rejected. While the key
|
||||
name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The RESTORE operation is subject to security
|
||||
constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have RESTORE permission in the target Key Vault. This operation requires the keys/restore permission.
|
||||
Imports a previously backed up key into Azure Key Vault, restoring the key, its key identifier, attributes and access control policies. The RESTORE operation may be used to import a previously backed up key. Individual
|
||||
versions of a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the RESTORE operation will be
|
||||
rejected. While the key name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The RESTORE
|
||||
operation is subject to security constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have RESTORE permission in the target Key Vault. This operation
|
||||
requires the keys/restore permission.
|
||||
summary: Restores a backed up key to a vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -7948,9 +7949,9 @@ operationGroups:
|
|||
default:
|
||||
name: encrypt
|
||||
description: >-
|
||||
The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the
|
||||
target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the
|
||||
key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission.
|
||||
The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on
|
||||
the target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public
|
||||
portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission.
|
||||
summary: Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -8110,9 +8111,9 @@ operationGroups:
|
|||
default:
|
||||
name: decrypt
|
||||
description: >-
|
||||
The DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the ENCRYPT operation; only a single block of data may be decrypted, the
|
||||
size of this block is dependent on the target key and the algorithm to be used. The DECRYPT operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation
|
||||
requires the keys/decrypt permission.
|
||||
The DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the ENCRYPT operation; only a single block of data may be decrypted,
|
||||
the size of this block is dependent on the target key and the algorithm to be used. The DECRYPT operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This
|
||||
operation requires the keys/decrypt permission.
|
||||
summary: Decrypts a single block of encrypted data.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -8442,8 +8443,8 @@ operationGroups:
|
|||
default:
|
||||
name: verify
|
||||
description: >-
|
||||
The VERIFY operation is applicable to symmetric keys stored in Azure Key Vault. VERIFY is not strictly necessary for asymmetric keys stored in Azure Key Vault since signature verification can be performed using the public portion
|
||||
of the key but this operation is supported as a convenience for callers that only have a key-reference and not the public portion of the key. This operation requires the keys/verify permission.
|
||||
The VERIFY operation is applicable to symmetric keys stored in Azure Key Vault. VERIFY is not strictly necessary for asymmetric keys stored in Azure Key Vault since signature verification can be performed using the public
|
||||
portion of the key but this operation is supported as a convenience for callers that only have a key-reference and not the public portion of the key. This operation requires the keys/verify permission.
|
||||
summary: Verifies a signature using a specified key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -8603,9 +8604,9 @@ operationGroups:
|
|||
default:
|
||||
name: wrapKey
|
||||
description: >-
|
||||
The WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation is only strictly necessary for symmetric keys stored in Azure Key Vault
|
||||
since protection with an asymmetric key can be performed using the public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the
|
||||
public key material. This operation requires the keys/wrapKey permission.
|
||||
The WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation is only strictly necessary for symmetric keys stored in Azure Key
|
||||
Vault since protection with an asymmetric key can be performed using the public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access
|
||||
to the public key material. This operation requires the keys/wrapKey permission.
|
||||
summary: Wraps a symmetric key using a specified key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -8765,8 +8766,8 @@ operationGroups:
|
|||
default:
|
||||
name: unwrapKey
|
||||
description: >-
|
||||
The UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The UNWRAP operation applies to asymmetric and symmetric keys stored in Azure
|
||||
Key Vault since it uses the private portion of the key. This operation requires the keys/unwrapKey permission.
|
||||
The UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The UNWRAP operation applies to asymmetric and symmetric keys stored in
|
||||
Azure Key Vault since it uses the private portion of the key. This operation requires the keys/unwrapKey permission.
|
||||
summary: Unwraps a symmetric key using the specified key that was initially used for wrapping that key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -8874,8 +8875,8 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedKeys
|
||||
description: >-
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults
|
||||
enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for
|
||||
vaults enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.
|
||||
paging:
|
||||
nextLinkName: nextLink
|
||||
summary: Lists the deleted keys in the specified vault.
|
||||
|
|
@ -10878,7 +10879,9 @@ operationGroups:
|
|||
language: !<!Languages>
|
||||
default:
|
||||
name: DeleteCertificate
|
||||
description: Deletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a certificate object. This operation requires the certificates/delete permission.
|
||||
description: >-
|
||||
Deletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a certificate object. This operation requires the certificates/delete
|
||||
permission.
|
||||
summary: Deletes a certificate from a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -13891,8 +13894,8 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedCertificates
|
||||
description: >-
|
||||
The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires
|
||||
the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.
|
||||
The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation
|
||||
requires the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.
|
||||
paging:
|
||||
nextLinkName: nextLink
|
||||
summary: Lists the deleted certificates in the specified vault currently available for recovery.
|
||||
|
|
@ -14032,8 +14035,8 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedCertificate
|
||||
description: >-
|
||||
The GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires the
|
||||
certificates/get permission.
|
||||
The GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires
|
||||
the certificates/get permission.
|
||||
summary: Retrieves information about the specified deleted certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
|
|||
|
|
@ -2236,8 +2236,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: recoveryLevel
|
||||
description: >-
|
||||
Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge
|
||||
the secret, at the end of the retention interval.
|
||||
Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system
|
||||
can purge the secret, at the end of the retention interval.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -2269,8 +2269,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: recoveryLevel
|
||||
description: >-
|
||||
Reflects the deletion recovery level currently in effect for certificates in the current vault. If it contains 'Purgeable', the certificate can be permanently deleted by a privileged user; otherwise, only the system
|
||||
can purge the certificate, at the end of the retention interval.
|
||||
Reflects the deletion recovery level currently in effect for certificates in the current vault. If it contains 'Purgeable', the certificate can be permanently deleted by a privileged user; otherwise, only
|
||||
the system can purge the certificate, at the end of the retention interval.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -2352,8 +2352,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: recoveryLevel
|
||||
description: >-
|
||||
Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key, at the
|
||||
end of the retention interval.
|
||||
Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key,
|
||||
at the end of the retention interval.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -5456,8 +5456,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: recoveryLevel
|
||||
description: >-
|
||||
Reflects the deletion recovery level currently in effect for storage accounts in the current vault. If it contains 'Purgeable' the storage account can be permanently deleted by a privileged user; otherwise, only the
|
||||
system can purge the storage account, at the end of the retention interval.
|
||||
Reflects the deletion recovery level currently in effect for storage accounts in the current vault. If it contains 'Purgeable' the storage account can be permanently deleted by a privileged user; otherwise,
|
||||
only the system can purge the storage account, at the end of the retention interval.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -6034,8 +6034,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: recoveryLevel
|
||||
description: >-
|
||||
Reflects the deletion recovery level currently in effect for SAS definitions in the current vault. If it contains 'Purgeable' the SAS definition can be permanently deleted by a privileged user; otherwise, only the
|
||||
system can purge the SAS definition, at the end of the retention interval.
|
||||
Reflects the deletion recovery level currently in effect for SAS definitions in the current vault. If it contains 'Purgeable' the SAS definition can be permanently deleted by a privileged user; otherwise, only
|
||||
the system can purge the SAS definition, at the end of the retention interval.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -7546,8 +7546,8 @@ operationGroups:
|
|||
default:
|
||||
name: GetKeys
|
||||
description: >-
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags
|
||||
are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and
|
||||
tags are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.
|
||||
paging:
|
||||
nextLinkName: nextLink
|
||||
summary: List keys in the specified vault.
|
||||
|
|
@ -7646,10 +7646,10 @@ operationGroups:
|
|||
name: BackupKey
|
||||
description: >-
|
||||
The Key Backup operation exports a key from Azure Key Vault in a protected form. Note that this operation does NOT return key material in a form that can be used outside the Azure Key Vault system, the returned key material is
|
||||
either protected to a Azure Key Vault HSM or to Azure Key Vault itself. The intent of this operation is to allow a client to GENERATE a key in one Azure Key Vault instance, BACKUP the key, and then RESTORE it into another Azure
|
||||
Key Vault instance. The BACKUP operation may be used to export, in protected form, any key type from Azure Key Vault. Individual versions of a key cannot be backed up. BACKUP / RESTORE can be performed within geographical
|
||||
boundaries only; meaning that a BACKUP from one geographical area cannot be restored to another geographical area. For example, a backup from the US geographical area cannot be restored in an EU geographical area. This operation
|
||||
requires the key/backup permission.
|
||||
either protected to a Azure Key Vault HSM or to Azure Key Vault itself. The intent of this operation is to allow a client to GENERATE a key in one Azure Key Vault instance, BACKUP the key, and then RESTORE it into another
|
||||
Azure Key Vault instance. The BACKUP operation may be used to export, in protected form, any key type from Azure Key Vault. Individual versions of a key cannot be backed up. BACKUP / RESTORE can be performed within
|
||||
geographical boundaries only; meaning that a BACKUP from one geographical area cannot be restored to another geographical area. For example, a backup from the US geographical area cannot be restored in an EU geographical area.
|
||||
This operation requires the key/backup permission.
|
||||
summary: Requests that a backup of the specified key be downloaded to the client.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -7785,10 +7785,11 @@ operationGroups:
|
|||
default:
|
||||
name: RestoreKey
|
||||
description: >-
|
||||
Imports a previously backed up key into Azure Key Vault, restoring the key, its key identifier, attributes and access control policies. The RESTORE operation may be used to import a previously backed up key. Individual versions of
|
||||
a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the RESTORE operation will be rejected. While the key
|
||||
name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The RESTORE operation is subject to security
|
||||
constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have RESTORE permission in the target Key Vault. This operation requires the keys/restore permission.
|
||||
Imports a previously backed up key into Azure Key Vault, restoring the key, its key identifier, attributes and access control policies. The RESTORE operation may be used to import a previously backed up key. Individual
|
||||
versions of a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the RESTORE operation will be
|
||||
rejected. While the key name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The RESTORE
|
||||
operation is subject to security constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have RESTORE permission in the target Key Vault. This operation
|
||||
requires the keys/restore permission.
|
||||
summary: Restores a backed up key to a vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -7948,9 +7949,9 @@ operationGroups:
|
|||
default:
|
||||
name: encrypt
|
||||
description: >-
|
||||
The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the
|
||||
target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the
|
||||
key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission.
|
||||
The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on
|
||||
the target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public
|
||||
portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission.
|
||||
summary: Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -8110,9 +8111,9 @@ operationGroups:
|
|||
default:
|
||||
name: decrypt
|
||||
description: >-
|
||||
The DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the ENCRYPT operation; only a single block of data may be decrypted, the
|
||||
size of this block is dependent on the target key and the algorithm to be used. The DECRYPT operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation
|
||||
requires the keys/decrypt permission.
|
||||
The DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the ENCRYPT operation; only a single block of data may be decrypted,
|
||||
the size of this block is dependent on the target key and the algorithm to be used. The DECRYPT operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This
|
||||
operation requires the keys/decrypt permission.
|
||||
summary: Decrypts a single block of encrypted data.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -8442,8 +8443,8 @@ operationGroups:
|
|||
default:
|
||||
name: verify
|
||||
description: >-
|
||||
The VERIFY operation is applicable to symmetric keys stored in Azure Key Vault. VERIFY is not strictly necessary for asymmetric keys stored in Azure Key Vault since signature verification can be performed using the public portion
|
||||
of the key but this operation is supported as a convenience for callers that only have a key-reference and not the public portion of the key. This operation requires the keys/verify permission.
|
||||
The VERIFY operation is applicable to symmetric keys stored in Azure Key Vault. VERIFY is not strictly necessary for asymmetric keys stored in Azure Key Vault since signature verification can be performed using the public
|
||||
portion of the key but this operation is supported as a convenience for callers that only have a key-reference and not the public portion of the key. This operation requires the keys/verify permission.
|
||||
summary: Verifies a signature using a specified key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -8603,9 +8604,9 @@ operationGroups:
|
|||
default:
|
||||
name: wrapKey
|
||||
description: >-
|
||||
The WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation is only strictly necessary for symmetric keys stored in Azure Key Vault
|
||||
since protection with an asymmetric key can be performed using the public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the
|
||||
public key material. This operation requires the keys/wrapKey permission.
|
||||
The WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation is only strictly necessary for symmetric keys stored in Azure Key
|
||||
Vault since protection with an asymmetric key can be performed using the public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access
|
||||
to the public key material. This operation requires the keys/wrapKey permission.
|
||||
summary: Wraps a symmetric key using a specified key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -8765,8 +8766,8 @@ operationGroups:
|
|||
default:
|
||||
name: unwrapKey
|
||||
description: >-
|
||||
The UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The UNWRAP operation applies to asymmetric and symmetric keys stored in Azure
|
||||
Key Vault since it uses the private portion of the key. This operation requires the keys/unwrapKey permission.
|
||||
The UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The UNWRAP operation applies to asymmetric and symmetric keys stored in
|
||||
Azure Key Vault since it uses the private portion of the key. This operation requires the keys/unwrapKey permission.
|
||||
summary: Unwraps a symmetric key using the specified key that was initially used for wrapping that key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -8874,8 +8875,8 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedKeys
|
||||
description: >-
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults
|
||||
enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for
|
||||
vaults enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.
|
||||
paging:
|
||||
nextLinkName: nextLink
|
||||
summary: Lists the deleted keys in the specified vault.
|
||||
|
|
@ -10878,7 +10879,9 @@ operationGroups:
|
|||
language: !<!Languages>
|
||||
default:
|
||||
name: DeleteCertificate
|
||||
description: Deletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a certificate object. This operation requires the certificates/delete permission.
|
||||
description: >-
|
||||
Deletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a certificate object. This operation requires the certificates/delete
|
||||
permission.
|
||||
summary: Deletes a certificate from a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -13891,8 +13894,8 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedCertificates
|
||||
description: >-
|
||||
The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires
|
||||
the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.
|
||||
The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation
|
||||
requires the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.
|
||||
paging:
|
||||
nextLinkName: nextLink
|
||||
summary: Lists the deleted certificates in the specified vault currently available for recovery.
|
||||
|
|
@ -14032,8 +14035,8 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedCertificate
|
||||
description: >-
|
||||
The GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires the
|
||||
certificates/get permission.
|
||||
The GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires
|
||||
the certificates/get permission.
|
||||
summary: Retrieves information about the specified deleted certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
|
|||
|
|
@ -2236,8 +2236,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: recoveryLevel
|
||||
description: >-
|
||||
Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge
|
||||
the secret, at the end of the retention interval.
|
||||
Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system
|
||||
can purge the secret, at the end of the retention interval.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -2269,8 +2269,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: recoveryLevel
|
||||
description: >-
|
||||
Reflects the deletion recovery level currently in effect for certificates in the current vault. If it contains 'Purgeable', the certificate can be permanently deleted by a privileged user; otherwise, only the system
|
||||
can purge the certificate, at the end of the retention interval.
|
||||
Reflects the deletion recovery level currently in effect for certificates in the current vault. If it contains 'Purgeable', the certificate can be permanently deleted by a privileged user; otherwise, only
|
||||
the system can purge the certificate, at the end of the retention interval.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -2352,8 +2352,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: recoveryLevel
|
||||
description: >-
|
||||
Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key, at the
|
||||
end of the retention interval.
|
||||
Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key,
|
||||
at the end of the retention interval.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -5456,8 +5456,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: recoveryLevel
|
||||
description: >-
|
||||
Reflects the deletion recovery level currently in effect for storage accounts in the current vault. If it contains 'Purgeable' the storage account can be permanently deleted by a privileged user; otherwise, only the
|
||||
system can purge the storage account, at the end of the retention interval.
|
||||
Reflects the deletion recovery level currently in effect for storage accounts in the current vault. If it contains 'Purgeable' the storage account can be permanently deleted by a privileged user; otherwise,
|
||||
only the system can purge the storage account, at the end of the retention interval.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -6034,8 +6034,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: recoveryLevel
|
||||
description: >-
|
||||
Reflects the deletion recovery level currently in effect for SAS definitions in the current vault. If it contains 'Purgeable' the SAS definition can be permanently deleted by a privileged user; otherwise, only the
|
||||
system can purge the SAS definition, at the end of the retention interval.
|
||||
Reflects the deletion recovery level currently in effect for SAS definitions in the current vault. If it contains 'Purgeable' the SAS definition can be permanently deleted by a privileged user; otherwise, only
|
||||
the system can purge the SAS definition, at the end of the retention interval.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -7380,8 +7380,8 @@ operationGroups:
|
|||
default:
|
||||
name: GetKeys
|
||||
description: >-
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags
|
||||
are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and
|
||||
tags are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.
|
||||
paging:
|
||||
nextLinkName: nextLink
|
||||
summary: List keys in the specified vault.
|
||||
|
|
@ -7480,10 +7480,10 @@ operationGroups:
|
|||
name: BackupKey
|
||||
description: >-
|
||||
The Key Backup operation exports a key from Azure Key Vault in a protected form. Note that this operation does NOT return key material in a form that can be used outside the Azure Key Vault system, the returned key material is
|
||||
either protected to a Azure Key Vault HSM or to Azure Key Vault itself. The intent of this operation is to allow a client to GENERATE a key in one Azure Key Vault instance, BACKUP the key, and then RESTORE it into another Azure
|
||||
Key Vault instance. The BACKUP operation may be used to export, in protected form, any key type from Azure Key Vault. Individual versions of a key cannot be backed up. BACKUP / RESTORE can be performed within geographical
|
||||
boundaries only; meaning that a BACKUP from one geographical area cannot be restored to another geographical area. For example, a backup from the US geographical area cannot be restored in an EU geographical area. This operation
|
||||
requires the key/backup permission.
|
||||
either protected to a Azure Key Vault HSM or to Azure Key Vault itself. The intent of this operation is to allow a client to GENERATE a key in one Azure Key Vault instance, BACKUP the key, and then RESTORE it into another
|
||||
Azure Key Vault instance. The BACKUP operation may be used to export, in protected form, any key type from Azure Key Vault. Individual versions of a key cannot be backed up. BACKUP / RESTORE can be performed within
|
||||
geographical boundaries only; meaning that a BACKUP from one geographical area cannot be restored to another geographical area. For example, a backup from the US geographical area cannot be restored in an EU geographical area.
|
||||
This operation requires the key/backup permission.
|
||||
summary: Requests that a backup of the specified key be downloaded to the client.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -7606,10 +7606,11 @@ operationGroups:
|
|||
default:
|
||||
name: RestoreKey
|
||||
description: >-
|
||||
Imports a previously backed up key into Azure Key Vault, restoring the key, its key identifier, attributes and access control policies. The RESTORE operation may be used to import a previously backed up key. Individual versions of
|
||||
a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the RESTORE operation will be rejected. While the key
|
||||
name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The RESTORE operation is subject to security
|
||||
constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have RESTORE permission in the target Key Vault. This operation requires the keys/restore permission.
|
||||
Imports a previously backed up key into Azure Key Vault, restoring the key, its key identifier, attributes and access control policies. The RESTORE operation may be used to import a previously backed up key. Individual
|
||||
versions of a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the RESTORE operation will be
|
||||
rejected. While the key name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The RESTORE
|
||||
operation is subject to security constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have RESTORE permission in the target Key Vault. This operation
|
||||
requires the keys/restore permission.
|
||||
summary: Restores a backed up key to a vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -7743,9 +7744,9 @@ operationGroups:
|
|||
default:
|
||||
name: encrypt
|
||||
description: >-
|
||||
The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the
|
||||
target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the
|
||||
key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission.
|
||||
The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on
|
||||
the target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public
|
||||
portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission.
|
||||
summary: Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -7879,9 +7880,9 @@ operationGroups:
|
|||
default:
|
||||
name: decrypt
|
||||
description: >-
|
||||
The DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the ENCRYPT operation; only a single block of data may be decrypted, the
|
||||
size of this block is dependent on the target key and the algorithm to be used. The DECRYPT operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation
|
||||
requires the keys/decrypt permission.
|
||||
The DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the ENCRYPT operation; only a single block of data may be decrypted,
|
||||
the size of this block is dependent on the target key and the algorithm to be used. The DECRYPT operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This
|
||||
operation requires the keys/decrypt permission.
|
||||
summary: Decrypts a single block of encrypted data.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -8146,8 +8147,8 @@ operationGroups:
|
|||
default:
|
||||
name: verify
|
||||
description: >-
|
||||
The VERIFY operation is applicable to symmetric keys stored in Azure Key Vault. VERIFY is not strictly necessary for asymmetric keys stored in Azure Key Vault since signature verification can be performed using the public portion
|
||||
of the key but this operation is supported as a convenience for callers that only have a key-reference and not the public portion of the key. This operation requires the keys/verify permission.
|
||||
The VERIFY operation is applicable to symmetric keys stored in Azure Key Vault. VERIFY is not strictly necessary for asymmetric keys stored in Azure Key Vault since signature verification can be performed using the public
|
||||
portion of the key but this operation is supported as a convenience for callers that only have a key-reference and not the public portion of the key. This operation requires the keys/verify permission.
|
||||
summary: Verifies a signature using a specified key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -8281,9 +8282,9 @@ operationGroups:
|
|||
default:
|
||||
name: wrapKey
|
||||
description: >-
|
||||
The WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation is only strictly necessary for symmetric keys stored in Azure Key Vault
|
||||
since protection with an asymmetric key can be performed using the public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the
|
||||
public key material. This operation requires the keys/wrapKey permission.
|
||||
The WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation is only strictly necessary for symmetric keys stored in Azure Key
|
||||
Vault since protection with an asymmetric key can be performed using the public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access
|
||||
to the public key material. This operation requires the keys/wrapKey permission.
|
||||
summary: Wraps a symmetric key using a specified key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -8417,8 +8418,8 @@ operationGroups:
|
|||
default:
|
||||
name: unwrapKey
|
||||
description: >-
|
||||
The UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The UNWRAP operation applies to asymmetric and symmetric keys stored in Azure
|
||||
Key Vault since it uses the private portion of the key. This operation requires the keys/unwrapKey permission.
|
||||
The UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The UNWRAP operation applies to asymmetric and symmetric keys stored in
|
||||
Azure Key Vault since it uses the private portion of the key. This operation requires the keys/unwrapKey permission.
|
||||
summary: Unwraps a symmetric key using the specified key that was initially used for wrapping that key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -8526,8 +8527,8 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedKeys
|
||||
description: >-
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults
|
||||
enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for
|
||||
vaults enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.
|
||||
paging:
|
||||
nextLinkName: nextLink
|
||||
summary: Lists the deleted keys in the specified vault.
|
||||
|
|
@ -10429,7 +10430,9 @@ operationGroups:
|
|||
language: !<!Languages>
|
||||
default:
|
||||
name: DeleteCertificate
|
||||
description: Deletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a certificate object. This operation requires the certificates/delete permission.
|
||||
description: >-
|
||||
Deletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a certificate object. This operation requires the certificates/delete
|
||||
permission.
|
||||
summary: Deletes a certificate from a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -13128,8 +13131,8 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedCertificates
|
||||
description: >-
|
||||
The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires
|
||||
the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.
|
||||
The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation
|
||||
requires the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.
|
||||
paging:
|
||||
nextLinkName: nextLink
|
||||
summary: Lists the deleted certificates in the specified vault currently available for recovery.
|
||||
|
|
@ -13269,8 +13272,8 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedCertificate
|
||||
description: >-
|
||||
The GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires the
|
||||
certificates/get permission.
|
||||
The GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires
|
||||
the certificates/get permission.
|
||||
summary: Retrieves information about the specified deleted certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
|
|||
|
|
@ -2236,8 +2236,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: recoveryLevel
|
||||
description: >-
|
||||
Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge
|
||||
the secret, at the end of the retention interval.
|
||||
Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system
|
||||
can purge the secret, at the end of the retention interval.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -2269,8 +2269,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: recoveryLevel
|
||||
description: >-
|
||||
Reflects the deletion recovery level currently in effect for certificates in the current vault. If it contains 'Purgeable', the certificate can be permanently deleted by a privileged user; otherwise, only the system
|
||||
can purge the certificate, at the end of the retention interval.
|
||||
Reflects the deletion recovery level currently in effect for certificates in the current vault. If it contains 'Purgeable', the certificate can be permanently deleted by a privileged user; otherwise, only
|
||||
the system can purge the certificate, at the end of the retention interval.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -2352,8 +2352,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: recoveryLevel
|
||||
description: >-
|
||||
Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key, at the
|
||||
end of the retention interval.
|
||||
Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key,
|
||||
at the end of the retention interval.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -5456,8 +5456,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: recoveryLevel
|
||||
description: >-
|
||||
Reflects the deletion recovery level currently in effect for storage accounts in the current vault. If it contains 'Purgeable' the storage account can be permanently deleted by a privileged user; otherwise, only the
|
||||
system can purge the storage account, at the end of the retention interval.
|
||||
Reflects the deletion recovery level currently in effect for storage accounts in the current vault. If it contains 'Purgeable' the storage account can be permanently deleted by a privileged user; otherwise,
|
||||
only the system can purge the storage account, at the end of the retention interval.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -6034,8 +6034,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: recoveryLevel
|
||||
description: >-
|
||||
Reflects the deletion recovery level currently in effect for SAS definitions in the current vault. If it contains 'Purgeable' the SAS definition can be permanently deleted by a privileged user; otherwise, only the
|
||||
system can purge the SAS definition, at the end of the retention interval.
|
||||
Reflects the deletion recovery level currently in effect for SAS definitions in the current vault. If it contains 'Purgeable' the SAS definition can be permanently deleted by a privileged user; otherwise, only
|
||||
the system can purge the SAS definition, at the end of the retention interval.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -7546,8 +7546,8 @@ operationGroups:
|
|||
default:
|
||||
name: GetKeys
|
||||
description: >-
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags
|
||||
are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and
|
||||
tags are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.
|
||||
paging:
|
||||
nextLinkName: nextLink
|
||||
summary: List keys in the specified vault.
|
||||
|
|
@ -7646,10 +7646,10 @@ operationGroups:
|
|||
name: BackupKey
|
||||
description: >-
|
||||
The Key Backup operation exports a key from Azure Key Vault in a protected form. Note that this operation does NOT return key material in a form that can be used outside the Azure Key Vault system, the returned key material is
|
||||
either protected to a Azure Key Vault HSM or to Azure Key Vault itself. The intent of this operation is to allow a client to GENERATE a key in one Azure Key Vault instance, BACKUP the key, and then RESTORE it into another Azure
|
||||
Key Vault instance. The BACKUP operation may be used to export, in protected form, any key type from Azure Key Vault. Individual versions of a key cannot be backed up. BACKUP / RESTORE can be performed within geographical
|
||||
boundaries only; meaning that a BACKUP from one geographical area cannot be restored to another geographical area. For example, a backup from the US geographical area cannot be restored in an EU geographical area. This operation
|
||||
requires the key/backup permission.
|
||||
either protected to a Azure Key Vault HSM or to Azure Key Vault itself. The intent of this operation is to allow a client to GENERATE a key in one Azure Key Vault instance, BACKUP the key, and then RESTORE it into another
|
||||
Azure Key Vault instance. The BACKUP operation may be used to export, in protected form, any key type from Azure Key Vault. Individual versions of a key cannot be backed up. BACKUP / RESTORE can be performed within
|
||||
geographical boundaries only; meaning that a BACKUP from one geographical area cannot be restored to another geographical area. For example, a backup from the US geographical area cannot be restored in an EU geographical area.
|
||||
This operation requires the key/backup permission.
|
||||
summary: Requests that a backup of the specified key be downloaded to the client.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -7785,10 +7785,11 @@ operationGroups:
|
|||
default:
|
||||
name: RestoreKey
|
||||
description: >-
|
||||
Imports a previously backed up key into Azure Key Vault, restoring the key, its key identifier, attributes and access control policies. The RESTORE operation may be used to import a previously backed up key. Individual versions of
|
||||
a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the RESTORE operation will be rejected. While the key
|
||||
name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The RESTORE operation is subject to security
|
||||
constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have RESTORE permission in the target Key Vault. This operation requires the keys/restore permission.
|
||||
Imports a previously backed up key into Azure Key Vault, restoring the key, its key identifier, attributes and access control policies. The RESTORE operation may be used to import a previously backed up key. Individual
|
||||
versions of a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the RESTORE operation will be
|
||||
rejected. While the key name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The RESTORE
|
||||
operation is subject to security constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have RESTORE permission in the target Key Vault. This operation
|
||||
requires the keys/restore permission.
|
||||
summary: Restores a backed up key to a vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -7948,9 +7949,9 @@ operationGroups:
|
|||
default:
|
||||
name: Encrypt
|
||||
description: >-
|
||||
The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the
|
||||
target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the
|
||||
key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission.
|
||||
The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on
|
||||
the target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public
|
||||
portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission.
|
||||
summary: Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -8110,9 +8111,9 @@ operationGroups:
|
|||
default:
|
||||
name: Decrypt
|
||||
description: >-
|
||||
The DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the ENCRYPT operation; only a single block of data may be decrypted, the
|
||||
size of this block is dependent on the target key and the algorithm to be used. The DECRYPT operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation
|
||||
requires the keys/decrypt permission.
|
||||
The DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the ENCRYPT operation; only a single block of data may be decrypted,
|
||||
the size of this block is dependent on the target key and the algorithm to be used. The DECRYPT operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This
|
||||
operation requires the keys/decrypt permission.
|
||||
summary: Decrypts a single block of encrypted data.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -8442,8 +8443,8 @@ operationGroups:
|
|||
default:
|
||||
name: Verify
|
||||
description: >-
|
||||
The VERIFY operation is applicable to symmetric keys stored in Azure Key Vault. VERIFY is not strictly necessary for asymmetric keys stored in Azure Key Vault since signature verification can be performed using the public portion
|
||||
of the key but this operation is supported as a convenience for callers that only have a key-reference and not the public portion of the key. This operation requires the keys/verify permission.
|
||||
The VERIFY operation is applicable to symmetric keys stored in Azure Key Vault. VERIFY is not strictly necessary for asymmetric keys stored in Azure Key Vault since signature verification can be performed using the public
|
||||
portion of the key but this operation is supported as a convenience for callers that only have a key-reference and not the public portion of the key. This operation requires the keys/verify permission.
|
||||
summary: Verifies a signature using a specified key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -8603,9 +8604,9 @@ operationGroups:
|
|||
default:
|
||||
name: WrapKey
|
||||
description: >-
|
||||
The WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation is only strictly necessary for symmetric keys stored in Azure Key Vault
|
||||
since protection with an asymmetric key can be performed using the public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the
|
||||
public key material. This operation requires the keys/wrapKey permission.
|
||||
The WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation is only strictly necessary for symmetric keys stored in Azure Key
|
||||
Vault since protection with an asymmetric key can be performed using the public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access
|
||||
to the public key material. This operation requires the keys/wrapKey permission.
|
||||
summary: Wraps a symmetric key using a specified key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -8765,8 +8766,8 @@ operationGroups:
|
|||
default:
|
||||
name: UnwrapKey
|
||||
description: >-
|
||||
The UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The UNWRAP operation applies to asymmetric and symmetric keys stored in Azure
|
||||
Key Vault since it uses the private portion of the key. This operation requires the keys/unwrapKey permission.
|
||||
The UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The UNWRAP operation applies to asymmetric and symmetric keys stored in
|
||||
Azure Key Vault since it uses the private portion of the key. This operation requires the keys/unwrapKey permission.
|
||||
summary: Unwraps a symmetric key using the specified key that was initially used for wrapping that key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -8874,8 +8875,8 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedKeys
|
||||
description: >-
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults
|
||||
enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for
|
||||
vaults enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.
|
||||
paging:
|
||||
nextLinkName: nextLink
|
||||
summary: Lists the deleted keys in the specified vault.
|
||||
|
|
@ -10878,7 +10879,9 @@ operationGroups:
|
|||
language: !<!Languages>
|
||||
default:
|
||||
name: DeleteCertificate
|
||||
description: Deletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a certificate object. This operation requires the certificates/delete permission.
|
||||
description: >-
|
||||
Deletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a certificate object. This operation requires the certificates/delete
|
||||
permission.
|
||||
summary: Deletes a certificate from a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
@ -13891,8 +13894,8 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedCertificates
|
||||
description: >-
|
||||
The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires
|
||||
the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.
|
||||
The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation
|
||||
requires the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.
|
||||
paging:
|
||||
nextLinkName: nextLink
|
||||
summary: Lists the deleted certificates in the specified vault currently available for recovery.
|
||||
|
|
@ -14032,8 +14035,8 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedCertificate
|
||||
description: >-
|
||||
The GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires the
|
||||
certificates/get permission.
|
||||
The GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires
|
||||
the certificates/get permission.
|
||||
summary: Retrieves information about the specified deleted certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
|
|||
|
|
@ -518,43 +518,6 @@ schemas: !<!Schemas>
|
|||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_5
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 1.0.0
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_3
|
||||
serializedName: provisioningState
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningState
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_4
|
||||
readOnly: true
|
||||
serializedName: provisioningStateValues
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningStateValues
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-client-flatten: true
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: Product-properties
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema> &ref_26
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
@ -700,43 +663,6 @@ schemas: !<!Schemas>
|
|||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_18
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 1.0.0
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_16
|
||||
serializedName: provisioningState
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningState
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_17
|
||||
readOnly: true
|
||||
serializedName: provisioningStateValues
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningStateValues
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-client-flatten: true
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: SubProduct-properties
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
@ -2241,7 +2167,9 @@ operationGroups:
|
|||
language: !<!Languages>
|
||||
default:
|
||||
name: deleteProvisioning202Accepted200Succeeded
|
||||
description: 'Long running delete request, service returns a 202 to the initial request, with an entity that contains ProvisioningState=’Accepted’. Polls return this value until the last poll returns a ‘200’ with ProvisioningState=’Succeeded’'
|
||||
description: >-
|
||||
Long running delete request, service returns a 202 to the initial request, with an entity that contains ProvisioningState=’Accepted’. Polls return this value until the last poll returns a ‘200’ with
|
||||
ProvisioningState=’Succeeded’
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
@ -2387,7 +2315,9 @@ operationGroups:
|
|||
language: !<!Languages>
|
||||
default:
|
||||
name: deleteProvisioning202Deletingcanceled200
|
||||
description: 'Long running delete request, service returns a 202 to the initial request, with an entity that contains ProvisioningState=’Creating’. Polls return this value until the last poll returns a ‘200’ with ProvisioningState=’Canceled’'
|
||||
description: >-
|
||||
Long running delete request, service returns a 202 to the initial request, with an entity that contains ProvisioningState=’Creating’. Polls return this value until the last poll returns a ‘200’ with
|
||||
ProvisioningState=’Canceled’
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
@ -3316,8 +3246,8 @@ operationGroups:
|
|||
default:
|
||||
name: postDoubleHeadersFinalAzureHeaderGetDefault
|
||||
description: >-
|
||||
Long running post request, service returns a 202 to the initial request with both Location and Azure-Async header. Poll Azure-Async and it's success. Should NOT poll Location to get the final object if you support initial Autorest
|
||||
behavior.
|
||||
Long running post request, service returns a 202 to the initial request with both Location and Azure-Async header. Poll Azure-Async and it's success. Should NOT poll Location to get the final object if you support initial
|
||||
Autorest behavior.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
@ -4167,7 +4097,9 @@ operationGroups:
|
|||
language: !<!Languages>
|
||||
default:
|
||||
name: postAsyncRelativeRetrySucceeded
|
||||
description: 'Long running post request, service returns a 500, then a 202 to the initial request, with an entity that contains ProvisioningState=’Creating’. Poll the endpoint indicated in the Azure-AsyncOperation header for operation status'
|
||||
description: >-
|
||||
Long running post request, service returns a 500, then a 202 to the initial request, with an entity that contains ProvisioningState=’Creating’. Poll the endpoint indicated in the Azure-AsyncOperation header for operation
|
||||
status
|
||||
protocol: !<!Protocols> {}
|
||||
language: !<!Languages>
|
||||
default:
|
||||
|
|
@ -6305,8 +6237,8 @@ operationGroups:
|
|||
default:
|
||||
name: post202Retry200
|
||||
description: >-
|
||||
x-ms-client-request-id = 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0 is required message header for all requests. Long running post request, service returns a 202 to the initial request, with 'Location' and 'Retry-After' headers, Polls
|
||||
return a 200 with a response body after success
|
||||
x-ms-client-request-id = 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0 is required message header for all requests. Long running post request, service returns a 202 to the initial request, with 'Location' and 'Retry-After' headers,
|
||||
Polls return a 200 with a response body after success
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
|
|||
|
|
@ -518,43 +518,6 @@ schemas: !<!Schemas>
|
|||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_5
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 1.0.0
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_3
|
||||
serializedName: provisioningState
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningState
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_4
|
||||
readOnly: true
|
||||
serializedName: provisioningStateValues
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningStateValues
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-client-flatten: true
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: Product-properties
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema> &ref_26
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
@ -700,43 +663,6 @@ schemas: !<!Schemas>
|
|||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_18
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 1.0.0
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_16
|
||||
serializedName: provisioningState
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningState
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_17
|
||||
readOnly: true
|
||||
serializedName: provisioningStateValues
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningStateValues
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-client-flatten: true
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: SubProduct-properties
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
@ -2241,7 +2167,9 @@ operationGroups:
|
|||
language: !<!Languages>
|
||||
default:
|
||||
name: deleteProvisioning202Accepted200Succeeded
|
||||
description: 'Long running delete request, service returns a 202 to the initial request, with an entity that contains ProvisioningState=’Accepted’. Polls return this value until the last poll returns a ‘200’ with ProvisioningState=’Succeeded’'
|
||||
description: >-
|
||||
Long running delete request, service returns a 202 to the initial request, with an entity that contains ProvisioningState=’Accepted’. Polls return this value until the last poll returns a ‘200’ with
|
||||
ProvisioningState=’Succeeded’
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
@ -2387,7 +2315,9 @@ operationGroups:
|
|||
language: !<!Languages>
|
||||
default:
|
||||
name: deleteProvisioning202Deletingcanceled200
|
||||
description: 'Long running delete request, service returns a 202 to the initial request, with an entity that contains ProvisioningState=’Creating’. Polls return this value until the last poll returns a ‘200’ with ProvisioningState=’Canceled’'
|
||||
description: >-
|
||||
Long running delete request, service returns a 202 to the initial request, with an entity that contains ProvisioningState=’Creating’. Polls return this value until the last poll returns a ‘200’ with
|
||||
ProvisioningState=’Canceled’
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
@ -3316,8 +3246,8 @@ operationGroups:
|
|||
default:
|
||||
name: postDoubleHeadersFinalAzureHeaderGetDefault
|
||||
description: >-
|
||||
Long running post request, service returns a 202 to the initial request with both Location and Azure-Async header. Poll Azure-Async and it's success. Should NOT poll Location to get the final object if you support initial Autorest
|
||||
behavior.
|
||||
Long running post request, service returns a 202 to the initial request with both Location and Azure-Async header. Poll Azure-Async and it's success. Should NOT poll Location to get the final object if you support initial
|
||||
Autorest behavior.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
@ -4167,7 +4097,9 @@ operationGroups:
|
|||
language: !<!Languages>
|
||||
default:
|
||||
name: postAsyncRelativeRetrySucceeded
|
||||
description: 'Long running post request, service returns a 500, then a 202 to the initial request, with an entity that contains ProvisioningState=’Creating’. Poll the endpoint indicated in the Azure-AsyncOperation header for operation status'
|
||||
description: >-
|
||||
Long running post request, service returns a 500, then a 202 to the initial request, with an entity that contains ProvisioningState=’Creating’. Poll the endpoint indicated in the Azure-AsyncOperation header for operation
|
||||
status
|
||||
protocol: !<!Protocols> {}
|
||||
language: !<!Languages>
|
||||
default:
|
||||
|
|
@ -6305,8 +6237,8 @@ operationGroups:
|
|||
default:
|
||||
name: post202Retry200
|
||||
description: >-
|
||||
x-ms-client-request-id = 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0 is required message header for all requests. Long running post request, service returns a 202 to the initial request, with 'Location' and 'Retry-After' headers, Polls
|
||||
return a 200 with a response body after success
|
||||
x-ms-client-request-id = 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0 is required message header for all requests. Long running post request, service returns a 202 to the initial request, with 'Location' and 'Retry-After' headers,
|
||||
Polls return a 200 with a response body after success
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
|
|||
|
|
@ -2141,7 +2141,9 @@ operationGroups:
|
|||
language: !<!Languages>
|
||||
default:
|
||||
name: deleteProvisioning202Accepted200Succeeded
|
||||
description: 'Long running delete request, service returns a 202 to the initial request, with an entity that contains ProvisioningState=’Accepted’. Polls return this value until the last poll returns a ‘200’ with ProvisioningState=’Succeeded’'
|
||||
description: >-
|
||||
Long running delete request, service returns a 202 to the initial request, with an entity that contains ProvisioningState=’Accepted’. Polls return this value until the last poll returns a ‘200’ with
|
||||
ProvisioningState=’Succeeded’
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
@ -2287,7 +2289,9 @@ operationGroups:
|
|||
language: !<!Languages>
|
||||
default:
|
||||
name: deleteProvisioning202Deletingcanceled200
|
||||
description: 'Long running delete request, service returns a 202 to the initial request, with an entity that contains ProvisioningState=’Creating’. Polls return this value until the last poll returns a ‘200’ with ProvisioningState=’Canceled’'
|
||||
description: >-
|
||||
Long running delete request, service returns a 202 to the initial request, with an entity that contains ProvisioningState=’Creating’. Polls return this value until the last poll returns a ‘200’ with
|
||||
ProvisioningState=’Canceled’
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
@ -3216,8 +3220,8 @@ operationGroups:
|
|||
default:
|
||||
name: postDoubleHeadersFinalAzureHeaderGetDefault
|
||||
description: >-
|
||||
Long running post request, service returns a 202 to the initial request with both Location and Azure-Async header. Poll Azure-Async and it's success. Should NOT poll Location to get the final object if you support initial Autorest
|
||||
behavior.
|
||||
Long running post request, service returns a 202 to the initial request with both Location and Azure-Async header. Poll Azure-Async and it's success. Should NOT poll Location to get the final object if you support initial
|
||||
Autorest behavior.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
@ -4067,7 +4071,9 @@ operationGroups:
|
|||
language: !<!Languages>
|
||||
default:
|
||||
name: postAsyncRelativeRetrySucceeded
|
||||
description: 'Long running post request, service returns a 500, then a 202 to the initial request, with an entity that contains ProvisioningState=’Creating’. Poll the endpoint indicated in the Azure-AsyncOperation header for operation status'
|
||||
description: >-
|
||||
Long running post request, service returns a 500, then a 202 to the initial request, with an entity that contains ProvisioningState=’Creating’. Poll the endpoint indicated in the Azure-AsyncOperation header for operation
|
||||
status
|
||||
protocol: !<!Protocols> {}
|
||||
language: !<!Languages>
|
||||
default:
|
||||
|
|
@ -6205,8 +6211,8 @@ operationGroups:
|
|||
default:
|
||||
name: post202Retry200
|
||||
description: >-
|
||||
x-ms-client-request-id = 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0 is required message header for all requests. Long running post request, service returns a 202 to the initial request, with 'Location' and 'Retry-After' headers, Polls
|
||||
return a 200 with a response body after success
|
||||
x-ms-client-request-id = 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0 is required message header for all requests. Long running post request, service returns a 202 to the initial request, with 'Location' and 'Retry-After' headers,
|
||||
Polls return a 200 with a response body after success
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
|
|||
|
|
@ -518,43 +518,6 @@ schemas: !<!Schemas>
|
|||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_5
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 1.0.0
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_3
|
||||
serializedName: provisioningState
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningState
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_4
|
||||
readOnly: true
|
||||
serializedName: provisioningStateValues
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningStateValues
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-client-flatten: true
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: ProductProperties
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema> &ref_26
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
@ -700,43 +663,6 @@ schemas: !<!Schemas>
|
|||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_18
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 1.0.0
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_16
|
||||
serializedName: provisioningState
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningState
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_17
|
||||
readOnly: true
|
||||
serializedName: provisioningStateValues
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningStateValues
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-client-flatten: true
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: SubProductProperties
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
@ -2241,7 +2167,9 @@ operationGroups:
|
|||
language: !<!Languages>
|
||||
default:
|
||||
name: DeleteProvisioning202Accepted200Succeeded
|
||||
description: 'Long running delete request, service returns a 202 to the initial request, with an entity that contains ProvisioningState=’Accepted’. Polls return this value until the last poll returns a ‘200’ with ProvisioningState=’Succeeded’'
|
||||
description: >-
|
||||
Long running delete request, service returns a 202 to the initial request, with an entity that contains ProvisioningState=’Accepted’. Polls return this value until the last poll returns a ‘200’ with
|
||||
ProvisioningState=’Succeeded’
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
@ -2387,7 +2315,9 @@ operationGroups:
|
|||
language: !<!Languages>
|
||||
default:
|
||||
name: DeleteProvisioning202Deletingcanceled200
|
||||
description: 'Long running delete request, service returns a 202 to the initial request, with an entity that contains ProvisioningState=’Creating’. Polls return this value until the last poll returns a ‘200’ with ProvisioningState=’Canceled’'
|
||||
description: >-
|
||||
Long running delete request, service returns a 202 to the initial request, with an entity that contains ProvisioningState=’Creating’. Polls return this value until the last poll returns a ‘200’ with
|
||||
ProvisioningState=’Canceled’
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
@ -3316,8 +3246,8 @@ operationGroups:
|
|||
default:
|
||||
name: PostDoubleHeadersFinalAzureHeaderGetDefault
|
||||
description: >-
|
||||
Long running post request, service returns a 202 to the initial request with both Location and Azure-Async header. Poll Azure-Async and it's success. Should NOT poll Location to get the final object if you support initial Autorest
|
||||
behavior.
|
||||
Long running post request, service returns a 202 to the initial request with both Location and Azure-Async header. Poll Azure-Async and it's success. Should NOT poll Location to get the final object if you support initial
|
||||
Autorest behavior.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
@ -4167,7 +4097,9 @@ operationGroups:
|
|||
language: !<!Languages>
|
||||
default:
|
||||
name: PostAsyncRelativeRetrySucceeded
|
||||
description: 'Long running post request, service returns a 500, then a 202 to the initial request, with an entity that contains ProvisioningState=’Creating’. Poll the endpoint indicated in the Azure-AsyncOperation header for operation status'
|
||||
description: >-
|
||||
Long running post request, service returns a 500, then a 202 to the initial request, with an entity that contains ProvisioningState=’Creating’. Poll the endpoint indicated in the Azure-AsyncOperation header for operation
|
||||
status
|
||||
protocol: !<!Protocols> {}
|
||||
language: !<!Languages>
|
||||
default:
|
||||
|
|
@ -6305,8 +6237,8 @@ operationGroups:
|
|||
default:
|
||||
name: Post202Retry200
|
||||
description: >-
|
||||
x-ms-client-request-id = 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0 is required message header for all requests. Long running post request, service returns a 202 to the initial request, with 'Location' and 'Retry-After' headers, Polls
|
||||
return a 200 with a response body after success
|
||||
x-ms-client-request-id = 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0 is required message header for all requests. Long running post request, service returns a 202 to the initial request, with 'Location' and 'Retry-After' headers,
|
||||
Polls return a 200 with a response body after success
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
|
|||
|
|
@ -461,59 +461,6 @@ schemas: !<!Schemas>
|
|||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_2
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 1.0.0
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_9
|
||||
serializedName: p.name
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: p.name
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_10
|
||||
serializedName: type
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: type
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_11
|
||||
readOnly: true
|
||||
serializedName: provisioningStateValues
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningStateValues
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_12
|
||||
serializedName: provisioningState
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningState
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-client-flatten: true
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: FlattenedProduct-properties
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema> &ref_28
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
@ -727,67 +674,6 @@ schemas: !<!Schemas>
|
|||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_23
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 1.0.0
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_19
|
||||
required: true
|
||||
serializedName: max_product_display_name
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: max_product_display_name
|
||||
description: Display name of product.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_20
|
||||
required: true
|
||||
serializedName: max_product_capacity
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: capacity
|
||||
description: 'Capacity of product. For example, 4 people.'
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_21
|
||||
flattenedNames:
|
||||
- max_product_image
|
||||
- generic_value
|
||||
required: false
|
||||
serializedName: generic_value
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: generic_value
|
||||
description: Generic URL value.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_22
|
||||
flattenedNames:
|
||||
- max_product_image
|
||||
- '@odata.value'
|
||||
required: false
|
||||
serializedName: '@odata.value'
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: '@odata.value'
|
||||
description: URL value.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: SimpleProductProperties
|
||||
description: The product documentation.
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema> &ref_26
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
|
|||
|
|
@ -744,59 +744,6 @@ schemas: !<!Schemas>
|
|||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_2
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 1.0.0
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_9
|
||||
serializedName: p.name
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: p.name
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_10
|
||||
serializedName: type
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: type
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_11
|
||||
readOnly: true
|
||||
serializedName: provisioningStateValues
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningStateValues
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_12
|
||||
serializedName: provisioningState
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningState
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-client-flatten: true
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: FlattenedProduct-properties
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema> &ref_28
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
@ -904,67 +851,6 @@ schemas: !<!Schemas>
|
|||
protocol: !<!Protocols> {}
|
||||
- *ref_18
|
||||
- *ref_23
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 1.0.0
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_19
|
||||
required: true
|
||||
serializedName: max_product_display_name
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: max_product_display_name
|
||||
description: Display name of product.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_20
|
||||
required: true
|
||||
serializedName: max_product_capacity
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: capacity
|
||||
description: 'Capacity of product. For example, 4 people.'
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_21
|
||||
flattenedNames:
|
||||
- max_product_image
|
||||
- generic_value
|
||||
required: false
|
||||
serializedName: generic_value
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: generic_value
|
||||
description: Generic URL value.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_22
|
||||
flattenedNames:
|
||||
- max_product_image
|
||||
- '@odata.value'
|
||||
required: false
|
||||
serializedName: '@odata.value'
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: '@odata.value'
|
||||
description: URL value.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: SimpleProductProperties
|
||||
description: The product documentation.
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema> &ref_26
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
|
|||
|
|
@ -744,59 +744,6 @@ schemas: !<!Schemas>
|
|||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_2
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 1.0.0
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_9
|
||||
serializedName: p.name
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: pName
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_10
|
||||
serializedName: type
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: type
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_11
|
||||
readOnly: true
|
||||
serializedName: provisioningStateValues
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningStateValues
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_12
|
||||
serializedName: provisioningState
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningState
|
||||
description: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-client-flatten: true
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: FlattenedProductProperties
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema> &ref_36
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
@ -904,67 +851,6 @@ schemas: !<!Schemas>
|
|||
protocol: !<!Protocols> {}
|
||||
- *ref_17
|
||||
- *ref_14
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 1.0.0
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_18
|
||||
required: true
|
||||
serializedName: max_product_display_name
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: maxProductDisplayName
|
||||
description: Display name of product.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_19
|
||||
required: true
|
||||
serializedName: max_product_capacity
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: capacity
|
||||
description: 'Capacity of product. For example, 4 people.'
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_20
|
||||
flattenedNames:
|
||||
- max_product_image
|
||||
- generic_value
|
||||
required: false
|
||||
serializedName: generic_value
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: genericValue
|
||||
description: Generic URL value.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_21
|
||||
flattenedNames:
|
||||
- max_product_image
|
||||
- '@odata.value'
|
||||
required: false
|
||||
serializedName: '@odata.value'
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: odataValue
|
||||
description: URL value.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: SimpleProductProperties
|
||||
description: The product documentation.
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema> &ref_34
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
|
|||
|
|
@ -766,8 +766,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: lastGeoFailoverTime
|
||||
description: >-
|
||||
Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if
|
||||
the accountType is StandardGRS or StandardRAGRS.
|
||||
Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only
|
||||
available if the accountType is StandardGRS or StandardRAGRS.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_17
|
||||
|
|
@ -899,8 +899,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: customDomain
|
||||
description: >-
|
||||
User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name
|
||||
property.
|
||||
User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom
|
||||
domain name property.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -980,185 +980,12 @@ schemas: !<!Schemas>
|
|||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_22
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 2015-05-01-preview
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_8
|
||||
serializedName: accountType
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: accountType
|
||||
description: Gets or sets the account type.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: StorageAccountPropertiesCreateParameters
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_23
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 2015-05-01-preview
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_9
|
||||
serializedName: provisioningState
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningState
|
||||
description: Gets the status of the storage account at the time the operation was called.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_8
|
||||
serializedName: accountType
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: accountType
|
||||
description: Gets the type of the storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_13
|
||||
serializedName: primaryEndpoints
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: primaryEndpoints
|
||||
description: 'Gets the URLs that are used to perform a retrieval of a public blob, queue or table object.Note that StandardZRS and PremiumLRS accounts only return the blob endpoint.'
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_14
|
||||
serializedName: primaryLocation
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: primaryLocation
|
||||
description: Gets the location of the primary for the storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_15
|
||||
serializedName: statusOfPrimary
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: statusOfPrimary
|
||||
description: Gets the status indicating whether the primary location of the storage account is available or unavailable.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_16
|
||||
serializedName: lastGeoFailoverTime
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: lastGeoFailoverTime
|
||||
description: >-
|
||||
Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the
|
||||
accountType is StandardGRS or StandardRAGRS.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_17
|
||||
serializedName: secondaryLocation
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: secondaryLocation
|
||||
description: Gets the location of the geo replicated secondary for the storage account. Only available if the accountType is StandardGRS or StandardRAGRS.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_15
|
||||
serializedName: statusOfSecondary
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: statusOfSecondary
|
||||
description: Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the accountType is StandardGRS or StandardRAGRS.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_18
|
||||
serializedName: creationTime
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: creationTime
|
||||
description: Gets the creation date and time of the storage account in UTC.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_21
|
||||
serializedName: customDomain
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: customDomain
|
||||
description: Gets the user assigned custom domain assigned to this storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_13
|
||||
serializedName: secondaryEndpoints
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: secondaryEndpoints
|
||||
description: 'Gets the URLs that are used to perform a retrieval of a public blob, queue or table object from the secondary location of the storage account. Only available if the accountType is StandardRAGRS.'
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: StorageAccountProperties
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_13
|
||||
- *ref_30
|
||||
- *ref_31
|
||||
- *ref_21
|
||||
- *ref_24
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 2015-05-01-preview
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_8
|
||||
serializedName: accountType
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: accountType
|
||||
description: 'Gets or sets the account type. Note that StandardZRS and PremiumLRS accounts cannot be changed to other account types, and other account types cannot be changed to StandardZRS or PremiumLRS.'
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_21
|
||||
serializedName: customDomain
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: customDomain
|
||||
description: >-
|
||||
User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name
|
||||
property.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: StorageAccountPropertiesUpdateParameters
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema> &ref_68
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
@ -1624,8 +1451,8 @@ operationGroups:
|
|||
default:
|
||||
name: Create
|
||||
description: >-
|
||||
Asynchronously creates a new storage account with the specified parameters. Existing accounts cannot be updated with this API and should instead use the Update Storage Account API. If an account is already created and subsequent
|
||||
PUT request is issued with exact same set of properties, then HTTP 200 would be returned.
|
||||
Asynchronously creates a new storage account with the specified parameters. Existing accounts cannot be updated with this API and should instead use the Update Storage Account API. If an account is already created and
|
||||
subsequent PUT request is issued with exact same set of properties, then HTTP 200 would be returned.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
@ -1847,9 +1674,9 @@ operationGroups:
|
|||
default:
|
||||
name: Update
|
||||
description: >-
|
||||
Updates the account type or tags for a storage account. It can also be used to add a custom domain (note that custom domains cannot be added via the Create operation). Only one custom domain is supported per storage account. This
|
||||
API can only be used to update one of tags, accountType, or customDomain per call. To update multiple of these properties, call the API multiple times with one change per call. This call does not change the storage keys for the
|
||||
account. If you want to change storage account keys, use the RegenerateKey operation. The location and name of the storage account cannot be changed after creation.
|
||||
Updates the account type or tags for a storage account. It can also be used to add a custom domain (note that custom domains cannot be added via the Create operation). Only one custom domain is supported per storage account.
|
||||
This API can only be used to update one of tags, accountType, or customDomain per call. To update multiple of these properties, call the API multiple times with one change per call. This call does not change the storage keys
|
||||
for the account. If you want to change storage account keys, use the RegenerateKey operation. The location and name of the storage account cannot be changed after creation.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
|
|||
|
|
@ -766,8 +766,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: lastGeoFailoverTime
|
||||
description: >-
|
||||
Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if
|
||||
the accountType is StandardGRS or StandardRAGRS.
|
||||
Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only
|
||||
available if the accountType is StandardGRS or StandardRAGRS.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_17
|
||||
|
|
@ -899,8 +899,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: customDomain
|
||||
description: >-
|
||||
User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name
|
||||
property.
|
||||
User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom
|
||||
domain name property.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -980,185 +980,12 @@ schemas: !<!Schemas>
|
|||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_22
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 2015-05-01-preview
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_8
|
||||
serializedName: accountType
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: accountType
|
||||
description: Gets or sets the account type.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: StorageAccountPropertiesCreateParameters
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_23
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 2015-05-01-preview
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_9
|
||||
serializedName: provisioningState
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningState
|
||||
description: Gets the status of the storage account at the time the operation was called.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_8
|
||||
serializedName: accountType
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: accountType
|
||||
description: Gets the type of the storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_13
|
||||
serializedName: primaryEndpoints
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: primaryEndpoints
|
||||
description: 'Gets the URLs that are used to perform a retrieval of a public blob, queue or table object.Note that StandardZRS and PremiumLRS accounts only return the blob endpoint.'
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_14
|
||||
serializedName: primaryLocation
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: primaryLocation
|
||||
description: Gets the location of the primary for the storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_15
|
||||
serializedName: statusOfPrimary
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: statusOfPrimary
|
||||
description: Gets the status indicating whether the primary location of the storage account is available or unavailable.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_16
|
||||
serializedName: lastGeoFailoverTime
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: lastGeoFailoverTime
|
||||
description: >-
|
||||
Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the
|
||||
accountType is StandardGRS or StandardRAGRS.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_17
|
||||
serializedName: secondaryLocation
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: secondaryLocation
|
||||
description: Gets the location of the geo replicated secondary for the storage account. Only available if the accountType is StandardGRS or StandardRAGRS.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_15
|
||||
serializedName: statusOfSecondary
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: statusOfSecondary
|
||||
description: Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the accountType is StandardGRS or StandardRAGRS.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_18
|
||||
serializedName: creationTime
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: creationTime
|
||||
description: Gets the creation date and time of the storage account in UTC.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_21
|
||||
serializedName: customDomain
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: customDomain
|
||||
description: Gets the user assigned custom domain assigned to this storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_13
|
||||
serializedName: secondaryEndpoints
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: secondaryEndpoints
|
||||
description: 'Gets the URLs that are used to perform a retrieval of a public blob, queue or table object from the secondary location of the storage account. Only available if the accountType is StandardRAGRS.'
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: StorageAccountProperties
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_13
|
||||
- *ref_30
|
||||
- *ref_31
|
||||
- *ref_21
|
||||
- *ref_24
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 2015-05-01-preview
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_8
|
||||
serializedName: accountType
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: accountType
|
||||
description: 'Gets or sets the account type. Note that StandardZRS and PremiumLRS accounts cannot be changed to other account types, and other account types cannot be changed to StandardZRS or PremiumLRS.'
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_21
|
||||
serializedName: customDomain
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: customDomain
|
||||
description: >-
|
||||
User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name
|
||||
property.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: StorageAccountPropertiesUpdateParameters
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema> &ref_68
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
@ -1624,8 +1451,8 @@ operationGroups:
|
|||
default:
|
||||
name: Create
|
||||
description: >-
|
||||
Asynchronously creates a new storage account with the specified parameters. Existing accounts cannot be updated with this API and should instead use the Update Storage Account API. If an account is already created and subsequent
|
||||
PUT request is issued with exact same set of properties, then HTTP 200 would be returned.
|
||||
Asynchronously creates a new storage account with the specified parameters. Existing accounts cannot be updated with this API and should instead use the Update Storage Account API. If an account is already created and
|
||||
subsequent PUT request is issued with exact same set of properties, then HTTP 200 would be returned.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
@ -1847,9 +1674,9 @@ operationGroups:
|
|||
default:
|
||||
name: Update
|
||||
description: >-
|
||||
Updates the account type or tags for a storage account. It can also be used to add a custom domain (note that custom domains cannot be added via the Create operation). Only one custom domain is supported per storage account. This
|
||||
API can only be used to update one of tags, accountType, or customDomain per call. To update multiple of these properties, call the API multiple times with one change per call. This call does not change the storage keys for the
|
||||
account. If you want to change storage account keys, use the RegenerateKey operation. The location and name of the storage account cannot be changed after creation.
|
||||
Updates the account type or tags for a storage account. It can also be used to add a custom domain (note that custom domains cannot be added via the Create operation). Only one custom domain is supported per storage account.
|
||||
This API can only be used to update one of tags, accountType, or customDomain per call. To update multiple of these properties, call the API multiple times with one change per call. This call does not change the storage keys
|
||||
for the account. If you want to change storage account keys, use the RegenerateKey operation. The location and name of the storage account cannot be changed after creation.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
|
|||
|
|
@ -778,8 +778,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: lastGeoFailoverTime
|
||||
description: >-
|
||||
Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available
|
||||
if the accountType is StandardGRS or StandardRAGRS.
|
||||
Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only
|
||||
available if the accountType is StandardGRS or StandardRAGRS.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_16
|
||||
|
|
@ -916,8 +916,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: customDomain
|
||||
description: >-
|
||||
User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain
|
||||
name property.
|
||||
User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom
|
||||
domain name property.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -1464,8 +1464,8 @@ operationGroups:
|
|||
default:
|
||||
name: Create
|
||||
description: >-
|
||||
Asynchronously creates a new storage account with the specified parameters. Existing accounts cannot be updated with this API and should instead use the Update Storage Account API. If an account is already created and subsequent
|
||||
PUT request is issued with exact same set of properties, then HTTP 200 would be returned.
|
||||
Asynchronously creates a new storage account with the specified parameters. Existing accounts cannot be updated with this API and should instead use the Update Storage Account API. If an account is already created and
|
||||
subsequent PUT request is issued with exact same set of properties, then HTTP 200 would be returned.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
@ -1687,9 +1687,9 @@ operationGroups:
|
|||
default:
|
||||
name: Update
|
||||
description: >-
|
||||
Updates the account type or tags for a storage account. It can also be used to add a custom domain (note that custom domains cannot be added via the Create operation). Only one custom domain is supported per storage account. This
|
||||
API can only be used to update one of tags, accountType, or customDomain per call. To update multiple of these properties, call the API multiple times with one change per call. This call does not change the storage keys for the
|
||||
account. If you want to change storage account keys, use the RegenerateKey operation. The location and name of the storage account cannot be changed after creation.
|
||||
Updates the account type or tags for a storage account. It can also be used to add a custom domain (note that custom domains cannot be added via the Create operation). Only one custom domain is supported per storage account.
|
||||
This API can only be used to update one of tags, accountType, or customDomain per call. To update multiple of these properties, call the API multiple times with one change per call. This call does not change the storage keys
|
||||
for the account. If you want to change storage account keys, use the RegenerateKey operation. The location and name of the storage account cannot be changed after creation.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
|
|||
|
|
@ -766,8 +766,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: lastGeoFailoverTime
|
||||
description: >-
|
||||
Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if
|
||||
the accountType is StandardGRS or StandardRAGRS.
|
||||
Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only
|
||||
available if the accountType is StandardGRS or StandardRAGRS.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_17
|
||||
|
|
@ -899,8 +899,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: customDomain
|
||||
description: >-
|
||||
User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name
|
||||
property.
|
||||
User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom
|
||||
domain name property.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
|
|
@ -980,185 +980,12 @@ schemas: !<!Schemas>
|
|||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_22
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 2015-05-01-preview
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_8
|
||||
serializedName: accountType
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: accountType
|
||||
description: Gets or sets the account type.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: StorageAccountPropertiesCreateParameters
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_23
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 2015-05-01-preview
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_9
|
||||
serializedName: provisioningState
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: provisioningState
|
||||
description: Gets the status of the storage account at the time the operation was called.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_8
|
||||
serializedName: accountType
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: accountType
|
||||
description: Gets the type of the storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_13
|
||||
serializedName: primaryEndpoints
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: primaryEndpoints
|
||||
description: 'Gets the URLs that are used to perform a retrieval of a public blob, queue or table object.Note that StandardZRS and PremiumLRS accounts only return the blob endpoint.'
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_14
|
||||
serializedName: primaryLocation
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: primaryLocation
|
||||
description: Gets the location of the primary for the storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_15
|
||||
serializedName: statusOfPrimary
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: statusOfPrimary
|
||||
description: Gets the status indicating whether the primary location of the storage account is available or unavailable.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_16
|
||||
serializedName: lastGeoFailoverTime
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: lastGeoFailoverTime
|
||||
description: >-
|
||||
Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the
|
||||
accountType is StandardGRS or StandardRAGRS.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_17
|
||||
serializedName: secondaryLocation
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: secondaryLocation
|
||||
description: Gets the location of the geo replicated secondary for the storage account. Only available if the accountType is StandardGRS or StandardRAGRS.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_15
|
||||
serializedName: statusOfSecondary
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: statusOfSecondary
|
||||
description: Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the accountType is StandardGRS or StandardRAGRS.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_18
|
||||
serializedName: creationTime
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: creationTime
|
||||
description: Gets the creation date and time of the storage account in UTC.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_21
|
||||
serializedName: customDomain
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: customDomain
|
||||
description: Gets the user assigned custom domain assigned to this storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_13
|
||||
serializedName: secondaryEndpoints
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: secondaryEndpoints
|
||||
description: 'Gets the URLs that are used to perform a retrieval of a public blob, queue or table object from the secondary location of the storage account. Only available if the accountType is StandardRAGRS.'
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: StorageAccountProperties
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- *ref_13
|
||||
- *ref_30
|
||||
- *ref_31
|
||||
- *ref_21
|
||||
- *ref_24
|
||||
- !<!ObjectSchema>
|
||||
type: object
|
||||
apiVersions:
|
||||
- !<!ApiVersion>
|
||||
version: 2015-05-01-preview
|
||||
properties:
|
||||
- !<!Property>
|
||||
schema: *ref_8
|
||||
serializedName: accountType
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: accountType
|
||||
description: 'Gets or sets the account type. Note that StandardZRS and PremiumLRS accounts cannot be changed to other account types, and other account types cannot be changed to StandardZRS or PremiumLRS.'
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_21
|
||||
serializedName: customDomain
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: customDomain
|
||||
description: >-
|
||||
User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name
|
||||
property.
|
||||
protocol: !<!Protocols> {}
|
||||
serializationFormats:
|
||||
- json
|
||||
usage:
|
||||
- input
|
||||
- output
|
||||
extensions:
|
||||
x-ms-flattened: true
|
||||
language: !<!Languages>
|
||||
default:
|
||||
name: StorageAccountPropertiesUpdateParameters
|
||||
description: ''
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!ObjectSchema> &ref_68
|
||||
type: object
|
||||
apiVersions:
|
||||
|
|
@ -1624,8 +1451,8 @@ operationGroups:
|
|||
default:
|
||||
name: Create
|
||||
description: >-
|
||||
Asynchronously creates a new storage account with the specified parameters. Existing accounts cannot be updated with this API and should instead use the Update Storage Account API. If an account is already created and subsequent
|
||||
PUT request is issued with exact same set of properties, then HTTP 200 would be returned.
|
||||
Asynchronously creates a new storage account with the specified parameters. Existing accounts cannot be updated with this API and should instead use the Update Storage Account API. If an account is already created and
|
||||
subsequent PUT request is issued with exact same set of properties, then HTTP 200 would be returned.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
@ -1847,9 +1674,9 @@ operationGroups:
|
|||
default:
|
||||
name: Update
|
||||
description: >-
|
||||
Updates the account type or tags for a storage account. It can also be used to add a custom domain (note that custom domains cannot be added via the Create operation). Only one custom domain is supported per storage account. This
|
||||
API can only be used to update one of tags, accountType, or customDomain per call. To update multiple of these properties, call the API multiple times with one change per call. This call does not change the storage keys for the
|
||||
account. If you want to change storage account keys, use the RegenerateKey operation. The location and name of the storage account cannot be changed after creation.
|
||||
Updates the account type or tags for a storage account. It can also be used to add a custom domain (note that custom domains cannot be added via the Create operation). Only one custom domain is supported per storage account.
|
||||
This API can only be used to update one of tags, accountType, or customDomain per call. To update multiple of these properties, call the API multiple times with one change per call. This call does not change the storage keys
|
||||
for the account. If you want to change storage account keys, use the RegenerateKey operation. The location and name of the storage account cannot be changed after creation.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
|
|||
|
|
@ -2467,8 +2467,8 @@ operationGroups:
|
|||
default:
|
||||
name: EntitiesRecognitionPii
|
||||
description: >
|
||||
The API returns a list of entities with personal information (\"SSN\", \"Bank Account\" etc) in the document. For the list of supported entity types, check <a href="https://aka.ms/tanerpii">Supported Entity Types in Text Analytics
|
||||
API</a>. See the <a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.
|
||||
The API returns a list of entities with personal information (\"SSN\", \"Bank Account\" etc) in the document. For the list of supported entity types, check <a href="https://aka.ms/tanerpii">Supported Entity Types in Text
|
||||
Analytics API</a>. See the <a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.
|
||||
summary: Entities containing personal information
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
|
|||
|
|
@ -2467,8 +2467,8 @@ operationGroups:
|
|||
default:
|
||||
name: EntitiesRecognitionPii
|
||||
description: >
|
||||
The API returns a list of entities with personal information (\"SSN\", \"Bank Account\" etc) in the document. For the list of supported entity types, check <a href="https://aka.ms/tanerpii">Supported Entity Types in Text Analytics
|
||||
API</a>. See the <a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.
|
||||
The API returns a list of entities with personal information (\"SSN\", \"Bank Account\" etc) in the document. For the list of supported entity types, check <a href="https://aka.ms/tanerpii">Supported Entity Types in Text
|
||||
Analytics API</a>. See the <a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.
|
||||
summary: Entities containing personal information
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
|
|||
|
|
@ -2441,8 +2441,8 @@ operationGroups:
|
|||
default:
|
||||
name: EntitiesRecognitionPii
|
||||
description: >
|
||||
The API returns a list of entities with personal information (\"SSN\", \"Bank Account\" etc) in the document. For the list of supported entity types, check <a href="https://aka.ms/tanerpii">Supported Entity Types in Text Analytics
|
||||
API</a>. See the <a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.
|
||||
The API returns a list of entities with personal information (\"SSN\", \"Bank Account\" etc) in the document. For the list of supported entity types, check <a href="https://aka.ms/tanerpii">Supported Entity Types in Text
|
||||
Analytics API</a>. See the <a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.
|
||||
summary: Entities containing personal information
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
|
|||
|
|
@ -2467,8 +2467,8 @@ operationGroups:
|
|||
default:
|
||||
name: EntitiesRecognitionPii
|
||||
description: >
|
||||
The API returns a list of entities with personal information (\"SSN\", \"Bank Account\" etc) in the document. For the list of supported entity types, check <a href="https://aka.ms/tanerpii">Supported Entity Types in Text Analytics
|
||||
API</a>. See the <a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.
|
||||
The API returns a list of entities with personal information (\"SSN\", \"Bank Account\" etc) in the document. For the list of supported entity types, check <a href="https://aka.ms/tanerpii">Supported Entity Types in Text
|
||||
Analytics API</a>. See the <a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.
|
||||
summary: Entities containing personal information
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
|
|
|
|||
|
|
@ -1881,8 +1881,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: AllowedOrigins
|
||||
description: >-
|
||||
The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match
|
||||
with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.
|
||||
The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive
|
||||
match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_48
|
||||
|
|
@ -1934,8 +1934,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: CorsRule
|
||||
description: >-
|
||||
CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from
|
||||
calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain
|
||||
CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page
|
||||
from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serialization:
|
||||
|
|
|
|||
|
|
@ -1881,8 +1881,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: AllowedOrigins
|
||||
description: >-
|
||||
The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match
|
||||
with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.
|
||||
The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive
|
||||
match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_48
|
||||
|
|
@ -1934,8 +1934,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: CorsRule
|
||||
description: >-
|
||||
CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from
|
||||
calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain
|
||||
CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page
|
||||
from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serialization:
|
||||
|
|
|
|||
|
|
@ -1881,8 +1881,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: AllowedOrigins
|
||||
description: >-
|
||||
The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match
|
||||
with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.
|
||||
The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive
|
||||
match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_34
|
||||
|
|
@ -1934,8 +1934,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: CorsRule
|
||||
description: >-
|
||||
CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from
|
||||
calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain
|
||||
CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page
|
||||
from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serialization:
|
||||
|
|
|
|||
|
|
@ -1881,8 +1881,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: allowedOrigins
|
||||
description: >-
|
||||
The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match
|
||||
with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.
|
||||
The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive
|
||||
match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Property>
|
||||
schema: *ref_48
|
||||
|
|
@ -1934,8 +1934,8 @@ schemas: !<!Schemas>
|
|||
default:
|
||||
name: CorsRule
|
||||
description: >-
|
||||
CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from
|
||||
calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain
|
||||
CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page
|
||||
from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain
|
||||
namespace: ''
|
||||
protocol: !<!Protocols> {}
|
||||
serialization:
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче